Sign in

v1

latestOpenAPI 3.0.02026-08-04891301.4 MB

List Slack channel bindings

Returns a page of Slack channel bindings visible to the authenticated user. Results can be filtered by integration, team, agent, or organization. Omit all filter params to retrieve every binding the caller can see.

Pagination is page-based. Pass page and per_page to navigate large result sets. page must be a positive integer; per_page must be between 1 and 100. Invalid values return 400.

get/api/v1/slack_channel_bindings

Query parameters

per_pageinteger

Number of bindings to return per page. Defaults to 25; maximum is 100.

pageinteger

Page number to retrieve, 1-indexed. Defaults to 1. Must be a positive integer.

teamstring[]

Return only bindings bound to one of these team IDs. Omit to return bindings for all teams.

orgstring[]

Return only bindings that belong to one of these organization IDs. Omit to return bindings across all organizations visible to the caller.

agentstring[]

Return only bindings that have at least one of these agent user IDs attached. Omit to return bindings regardless of agent attachment.

integrationstring[]

Return only bindings whose Slack integration matches one of these integration IDs. Omit to return bindings across all integrations.

Response

Successful response

pageinteger required

Current page number (1-indexed).

per_pageinteger required

Maximum number of bindings returned per page.

total_countinteger required

Total number of Slack channel bindings matching the query across all pages.

total_pagesinteger required

Total number of pages available at the current per_page size.

Example response

{
  "data": [
    {
      "agents": [
        "string"
      ],
      "channel": "C01234ABCDE",
      "customer_label": "string",
      "id": "string",
      "integration": "string",
      "is_ext_shared_cached": true,
      "team": "string"
    }
  ],
  "page": 1,
  "per_page": 20,
  "total_count": 1,
  "total_pages": 1
}