Slack Web API

/users.conversations

GET/users.conversations

List conversations the calling user may access.

Request

Query Params

token

string

optional

Authentication token. Requires scope: conversations:read

user

string

optional

Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership.

types

string

optional

Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im

exclude_archived

string

optional

Set to true to exclude archived channels from the list

limit

integer

optional

The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000.

cursor

string

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.

Request samples

Responses

Typical success response with only public channels. Note how `num_members` and `is_member` are not returned like typical `conversations` objects.(200)

Typical error response(500)

Typical success response with only public channels. Note how `num_members` and `is_member` are not returned like typical `conversations` objects.

HTTP Code: 200

Content Type : JSONapplication/json

channels

$ref(#/definitions/463255)[]

required

#/definitions/463255

optional

#/definitions/700149

required

response_metadata

object

optional

next_cursor

string

required

Additional properties

integer | number | string | boolean

optional

{
  "channels": [
    {
      "created": 1449252889,
      "creator": "U012A3CDE",
      "id": "C012AB3CD",
      "is_archived": false,
      "is_channel": true,
      "is_ext_shared": false,
      "is_general": true,
      "is_group": false,
      "is_im": false,
      "is_mpim": false,
      "is_org_shared": false,
      "is_pending_ext_shared": false,
      "is_private": false,
      "is_shared": false,
      "name": "general",
      "name_normalized": "general",
      "pending_shared": [],
      "previous_names": [],
      "purpose": {
        "creator": "",
        "last_set": 0,
        "value": "This channel is for team-wide communication and announcements. All team members are in this channel."
      },
      "topic": {
        "creator": "",
        "last_set": 0,
        "value": "Company-wide announcements and work-based matters"
      },
      "unlinked": 0
    },
    {
      "created": 1449252889,
      "creator": "U061F7AUR",
      "id": "C061EG9T2",
      "is_archived": false,
      "is_channel": true,
      "is_ext_shared": false,
      "is_general": false,
      "is_group": false,
      "is_im": false,
      "is_mpim": false,
      "is_org_shared": false,
      "is_pending_ext_shared": false,
      "is_private": false,
      "is_shared": false,
      "name": "random",
      "name_normalized": "random",
      "pending_shared": [],
      "previous_names": [],
      "purpose": {
        "creator": "",
        "last_set": 0,
        "value": "A place for non-work-related flimflam, faffing, hodge-podge or jibber-jabber you'd prefer to keep out of more focused work-related channels."
      },
      "topic": {
        "creator": "",
        "last_set": 0,
        "value": "Non-work banter and water cooler conversation"
      },
      "unlinked": 0
    }
  ],
  "ok": true,
  "response_metadata": {
    "next_cursor": "dGVhbTpDMDYxRkE1UEI="
  }
}

Last modified: a year ago