Listar canales activos de la company.
Channels
GET /v1/channels
List a company’s active channels, filterable by type.
GET
Listar canales activos de la company.
Returns the connected channels for the company tied to the PAT. Handy for discovering which channel to use when sending messages or registering webhooks.
Required scope:
If the id doesn’t exist or belongs to another company, it returns
channels:read
Query params
| Param | Type | Description |
|---|---|---|
type | optional enum | Filter by type. Values: whatsapp, whatsapp_qr, instagram, messenger, tiktok, web, playground. |
Request
Response 200
| Field | Type | Description |
|---|---|---|
id | string | Channel ID. Use it in POST /v1/messages (channel_id) and when filtering webhook deliveries. |
name | string | Channel display name. |
type | enum | Channel type. |
is_active | boolean | false only for channels that are paused or have credential issues. |
phone_number / phone_number_id / business_account_id | string | Only for type: whatsapp. |
Fetch a channel by id
GET /v1/channels/:id — same shape as a list item, no filters.
404 CHANNEL_NOT_FOUND.