users.conversations 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 method helps answer questions like:
- Which conversations am I a member of?
- Which public channels is my bot user in?
- Do I have any direct messages open with my friend Suzy?
- Is my bot a member of any private channels?
users.conversations returns a list of all channel-like conversations accessible to the user or app tied to the presented token, as part of our Conversations API.
Browse the public channel membership of other users with the user parameter. Private channel membership is only listed when the calling user, bot user, or app shares membership in a direct message, multi-person direct message, or private channel. Further filter channels by type with 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.
Response
Returns a list of limited channel-like conversation objects.
To get a full conversation object, call the conversations.info method. We omit the is_member and num_members fields in this method's response.
See conversation object for more detail on returned fields.
Pagination
This method uses cursor-based pagination to make it easier to incrementally collect information. To begin pagination, specify a limit value with a max of 999. 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.
Token support
Using a bot user token, this method returns the channels and conversations your bot is party to. Specifying a user parameter filters to conversations your bot shares with that user.
A user token armed with channels:read will similarly supply the channels the calling user is a member of. Supplying the user parameter narrows results to conversations featuring both the calling user and the identified user.