Skip to main content
GET
List channels

Authorizations

Authorization
string
header
required

A workspace API token (sk_live_...) or an OAuth access token (oat_live_...). Create workspace tokens in Settings > API. Send either as Authorization: Bearer <token>.

Query Parameters

platform
enum<string>[] | null

Only channels on this platform. Repeat to match any of several.

The messaging platform a channel runs on.

whatsapp_api is the official WhatsApp Business Platform, the only one that supports message templates. whatsapp is a number connected through the WhatsApp app. botconversa is a channel fed by an external chatbot integration.

Available options:
whatsapp_api,
whatsapp,
instagram,
slack,
web_widget,
botconversa
limit
integer
default:50

Items per page (max 200).

Required range: 1 <= x <= 200
cursor
string | null

Opaque cursor from a previous response's links.next.

Response

Successful Response

A page of channels.

data
Channel · object[]
required
meta
PageMeta · object
required