latestOpenAPI 3.1.02026-08-223321,1001.6 MB

2134ebffd1ef

channels

List Channels

get/channels/{platform}

Path parameters

platform'slack' | 'teams' | 'web' required

A supported chat platform.

Values align with integration_instances.type so a chat install's platform and its integration row stay in lockstep.

Query parameters

integration_idstring nullable

Chat integration instance to scope inventory to.

Chat integration instance to scope inventory to.

querystring nullable

Case-insensitive channel-name substring.

Case-insensitive channel-name substring.

pageinteger

Page number.

Page number.

limitinteger

Maximum channels returned per page.

Maximum channels returned per page.

Response

Successful Response

countinteger required
nextinteger nullable required
previnteger nullable required
totalinteger required