Sign in
Providers
Slack

List channels

List Slack channels for a Slack workspace.

get/v1/providers/slack/{channel_id}/channels

Path parameters

channel_idstring required

The ID of the Knock Slack channel to get channels for.

Query parameters

access_token_objectstring required

A JSON encoded string containing the access token object reference.

query_options.cursorstring

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.

query_options.limitinteger

The maximum number of channels to return.

query_options.exclude_archivedboolean

Set to true to exclude archived channels from the list.

query_options.typesstring

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

query_options.team_idstring

Encoded team ID (T1234) to list channels in, required if org token is used.

Response

OK

next_cursorstring nullable required

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.

Example response

{
  "next_cursor": null,
  "slack_channels": [
    {
      "context_team_id": "T01234567890",
      "id": "C01234567890",
      "is_im": false,
      "is_private": false,
      "name": "general"
    }
  ]
}

Changes