List available channels

List available channels/chats for a connected integration.

Also returns the connection’s currently-selected IDs so a picker can render the right boxes pre-checked without a second round trip.

GET /integrations/{integration_id}/channels

List available channels

cURL

curl --request GET \
  --url https://api.hyperspell.com/integrations/{integration_id}/channels \
  --header 'Authorization: Bearer <token>'

200

{
  "channels": [
    {
      "id": "<string>",
      "name": "<string>",
      "type": "channel"
    }
  ],
  "selected": [
    "<string>"
  ]
}

Authorizations

APIKeyAsUser

Authorization · string · header · required

API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.

Path Parameters

integration_id · string · required

Query Parameters

connection_id · string · required

The connection ID to use for listing channels

parent_id · string | null

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 reflect the leaf values stored in user_options.channels regardless of which level is queried.

Response

200

application/json

Successful Response

channels · ChannelInfo · object[] · required

Show child attributes

selected · string[]

IDs currently in connection.user_options.channels — pre-checked in pickers.