Skip to main content

List User Channels

List conversations the calling user may access.

External Documentation

To learn more, visit the Slack documentation.

Basic Parameters​

ParameterDescription
Channel TypesMix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im.
Exclude Archived?Check to exclude archived channels from the list.
LimitThe 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 PagesAutomatically fetch all resources, page by page.
User IDBrowse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership.

Advanced Parameters​

ParameterDescription
CursorPaginate 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​

{
    "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="
    }
}

Workflow Library Example​

List User Channels with Slack and Send Results Via Email

Workflow LibraryPreview this Workflow on desktop