conversations.list method
We're still building and not all features are available quite yet. Enjoy this peek into the future!
Not ready for the future? Return to the past at api.slack.com.
Usage info
This Conversations API method returns a list of all channel-like conversations in a workspace. The "channels" returned depend on what the calling token has access to and the directives placed in the types parameter.
The team_id is only relevant when using an org-level token. This field will be ignored if the API call is sent using a workspace-level token.
When paginating, any filters used in the request are applied after retrieving a virtual page's limit. For example, using exclude_archived=true when limit=20 on a virtual page that would contain 15 archived channels will return you the virtual page with only 5 results. Additional results are available from the next cursor value.
Response
Returns a list of limited channel-like conversation objects.
To get a full conversation object, call the conversations.info method.
Use conversations.members to retrieve and traverse membership.
See conversation object for more detail on returned fields.
Some fields in the response, like unread_count and unread_count_display, are included for DM conversations only.
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.