You must enable javascript in order to use the Slack API Documentation. You can do this in your browser settings.
Go to Slack

conversations.members

You're not signed into any teams. Sign in to test authentication.

Supported token types:

As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. A corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:.

This Conversations API method returns a paginated list of members party to a conversation.

Arguments

This method has the URL https://slack.com/api/conversations.members and follows the Slack Web API calling conventions.

Argument Example Required Description
token xxxx-xxxxxxxxx-xxxx Required

Authentication token bearing required scopes.

channel C1234567890 Required

ID of the conversation to retrieve members for

cursor dXNlcjpVMDYxTkZUVDI= Optional

Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.

limit 20 Optional, default=100

The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.

Present arguments as parameters in application/x-www-form-urlencoded querystring or POST body. This method does not currently accept application/json.

Response

Returns a list of user IDs belonging to the members in a conversation.

Typical paginated success response

{
    "ok": true,
    "members": [
        "U023BECGF",
        "U061F7AUR",
        "W012A3CDE"
    ],
    "response_metadata": {
        "next_cursor": "e3VzZXJfaWQ6IFcxMjM0NTY3fQ=="
    }
}

Typical error response when an invalid cursor is provided

{
    "ok": false,
    "error": "invalid_cursor"
}

Pagination

This method uses cursor-based pagination to make it easier to incrementally collect information. To begin pagination, specify a limit value under 1000. We recommend no more than 200 results at a time.

Responses will include a top-level response_metadata attribute containing a next_cursor value. By using this value as a cursor parameter in a subsequent request, along with limit, you may navigate through the collection page by virtual page.

See pagination for more information.

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok params in the response.

Error Description
method_not_supported_for_channel_type

This type of conversation cannot be used with this method.

missing_scope

The calling token is not granted the necessary scopes to complete this operation.

channel_not_found

Value passed for channel was invalid.

invalid_limit

Value passed for limit was invalid.

invalid_cursor

Value passed for cursor was invalid.

fetch_members_failed

Failed to fetch members for the conversation.

not_authed

No authentication token provided.

invalid_auth

Invalid authentication token.

account_inactive

Authentication token is for a deleted user or workspace.

no_permission

The workspace token used in this request does not have the permissions necessary to complete the request.

invalid_arg_name

The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.

invalid_array_arg

The method was passed a PHP-style array argument (e.g. with a name like foo[7]). These are never valid with the Slack API.

invalid_charset

The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.

invalid_form_data

The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.

invalid_post_type

The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/x-www-form-urlencoded multipart/form-data text/plain.

missing_post_type

The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.

team_added_to_org

The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.

request_timeout

The method was called via a POST request, but the POST data was either missing or truncated.

Warnings

This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.

Warning Description
missing_charset

The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.

superfluous_charset

The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous.

Argument Value
token Required Generate tokens to test with here.
channel Required
cursor Optional
limit Optional, default=100
Extra args