External DocumentationTo learn more, visit the Slack documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Channel Types | A comma-separated list of channel types to filter the channels you want to list. Available options: public_channel, private_channel, im, mpim.Note: When using the Slack Bot or Slack User connection types, private_channel and mpim channels cannot be listed.As an alternative, you can create your own Slack app by following our documentation and adding the required scopes: channels:read, groups:read, im:read, mpim:read. Follow the guide to create a token, then connect using the Token connection type. |
| Exclude Archived? | Check to exclude archived channels from the list. |
| Limit | 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. |
| Return All Pages | Automatically fetch all resources, page by page. |
| User ID | Browse conversations by a specific user ID’s membership. Can be obtained by using the List Users action.When using the Slack Bot or Slack User connection types, if you specify another user ID, you will only see conversations that are shared between the connected user (or bot) and that specified user. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Cursor | 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. To automatically fetch all pages of the collection, use the Return All Pages parameter. Note that you should use either the cursor or the Return All Pages parameter, but not both simultaneously.See pagination for more detail. |
Example Output
{
"ok": true,
"channels": [
{
"id": "<string>",
"name": "<string>",
"is_channel": true,
"is_group": false,
"is_im": false,
"is_mpim": false,
"is_private": false,
"created": 1478482360,
"is_archived": false,
"is_general": false,
"unlinked": 1,
"name_normalized": "<string>",
"is_shared": false,
"is_org_shared": false,
"is_pending_ext_shared": false,
"pending_shared": [],
"context_team_id": "<string>",
"updated": 2392766071469,
"parent_conversation": null,
"creator": "<string>",
"is_ext_shared": false,
"shared_team_ids": [
"<string>"
],
"pending_connected_team_ids": [],
"topic": {
"value": "<string>",
"creator": "<string>",
"last_set": 0
},
"purpose": {
"value": "<string>",
"creator": "<string>",
"last_set": 560042597
},
"properties": {
"tabs": [
{
"type": "<string>",
"label": "<string>",
"id": "<string>"
}
],
"tabz": [
{
"type": "<string>"
}
],
"use_case": "<string>"
},
"previous_names": []
},
{
"id": "<string>",
"name": "<string>",
"is_channel": true,
"is_group": false,
"is_im": false,
"is_mpim": false,
"is_private": false,
"created": 812967980,
"is_archived": false,
"is_general": true,
"unlinked": 2,
"name_normalized": "<string>",
"is_shared": false,
"is_org_shared": false,
"is_pending_ext_shared": false,
"pending_shared": [],
"context_team_id": "<string>",
"updated": 1637466759825,
"parent_conversation": null,
"creator": "<string>",
"is_ext_shared": false,
"shared_team_ids": [
"<string>"
],
"pending_connected_team_ids": [],
"topic": {
"value": "<string>",
"creator": "<string>",
"last_set": 1
},
"purpose": {
"value": "<string>",
"creator": "<string>",
"last_set": 3202247175
},
"properties": {
"canvas": {
"file_id": "<string>",
"quip_thread_id": "<string>"
},
"use_case": "<string>"
},
"previous_names": []
}
],
"response_metadata": {
"next_cursor": "<string>"
}
}