Integrations
Integrations

List available channels

Changed on

List available channels/chats for a connected integration.

Also returns the connection's currently selected channel IDs.

get/integrations/{integration_id}/channels

Request

  • Base URL
    https://api.hyperspell.com
  • URL
    https://api.hyperspell.com/integrations/{integration_id}/channels
  • Auth
    HTTP bearer

Path parameters

integration_idstring required

Query parameters

connection_idstring required

The connection ID to use for listing channels

parent_idstring nullable

For hierarchical providers (e.g. Microsoft Teams): omit to list root containers (workspaces); pass a container's id to list its children (sub-channels). Selected IDs in the response always identify leaf channels, regardless of which level is queried.

Headers

X-As-Userstring nullable

Optionally set this header to act as a specific user when using an API Key, equivalent to first exchanging the API Key for a User Token

Response

Successful Response

selectedstring[]

IDs currently selected for indexing.

pendingboolean

True while the provider's channel list is being walked in the background (large workspaces can take a minute) — poll again shortly; channels is empty and NOT the workspace's real state while pending.

truncatedboolean

True when the workspace has more channels than could be listed, so channels is incomplete. A saved non-empty selection indexes only the channels it contains, so channels that were not listed stop being indexed.

Changes