Endpoint ·
GET /channelsRead-only endpoint: it returns information and changes nothing. It is not sent inside the
actions array — you call it directly.key, prefixed with ch_). That key is the single most used value in the whole API: the channel field of the conversation reference is required in every action of POST /conversation/actions, and it is also accepted as an optional filter on several query endpoints.
Start here: list the channels once, store the key of the channel you will work with, and reuse it on every request. You can also copy it from the dashboard under Settings → Channels, field Channel key.
Parameters
- This endpoint takes no query parameters. It returns the complete list, unpaginated.
{slug}— business identifier in the path (required).Authorization: Bearer <key>— authentication header (required).
Response
true if this is the business testing channel. Useful to avoid sending real traffic to a test channel.Example
This is a read: theGET creates, modifies and deletes nothing. Its only purpose is to give you the key you will later put in channel when you run an action.
Full reference in Errors.
A channel key that does not exist does not fail here, but in the request that uses it: the action responds
404 (CHANNEL_NOT_FOUND). To see where channel fits inside an action group, see Actions — Overview; for the conversation resolution order, see Identify a conversation.