GET/v1/channelsstable

List channels

Needs: Read your data (mcp:read)
Plan: Any plan with API access
Limits: 300 a minute per key
Undo: Nothing to undo: this only reads.

Lists the channels connected to your workspace (WhatsApp numbers, Instagram, web chat, …). Use a channel id as channel_id when sending.

Try it

Query (4)

typeoptionalstring

Only this channel type.

searchoptionalstring

Name or number contains.

cursoroptionalstring

The `next_cursor` from the previous page. Cursors expire after 24 hours.

limitoptionalinteger

How many items per page (1–100).

This only reads. It uses your real data and changes nothing.

curl -X GET 'https://mcp.wa-api.cloud/v1/channels?type=whatsapp' \
  -H "Authorization: Bearer $API_KEY"

The code reads your key from $API_KEY.

Parameters

Parameters
Field	Type	What it is
type	string · query	Only this channel type.one of: `whatsapp`, `instagram`, `messenger`, `web`, `tiktok`, `telegram`, `email`, `sms`
search	string · query	Name or number contains.1–100 characters
cursor	string · query	The `next_cursor` from the previous page. Cursors expire after 24 hours.1–2048 characters
limit	integer · query	How many items per page (1–100).1–100 · default `25`

Headers

Headers
Field	Type	What it is
Authorizationrequired	header	`Bearer $API_KEY` — your API key.
Api-Version	header	The API version to use, e.g. `2026-10-01`. Default: the version your key is pinned to.one of: `2026-10-01` · pattern `^\d{4}-\d{2}-\d{2}$`

Response `200`

A page of channels.

Response fields
Field	Type	What it is
datarequired	array of object
idrequired	string	Workspace channel id — pass it as channelId to any tool (template and Flow tools accept it too).
meta_channel_idrequired	string or null	The same channel in the WhatsApp/Meta service; null when not linked.
namerequired	string or null
typerequired	string or null	whatsapp, instagram, messenger, web, …
identifierrequired	string or null	Business phone number, username or page shown for this channel.
is_defaultrequired	boolean
statusrequired	string	one of: `connected`, `disconnected`, `inactive`, `unknown`
web_surfacerequired	string or null	web / ios / android for web chat channels.
meta_phone_number_idrequired	string or null	Meta phone_number_id (WhatsApp) — an id, not a secret.
payment_configurationrequired	string or null
quality_ratingrequired	string or null	Meta quality rating; null = not exposed by the platform yet.
totalrequired	integer or null	-9007199254740991–9007199254740991
warningsrequired	array of string
next_cursorrequired	string or null	Pass as "cursor" to get the next page; null when there are no more results.

Errors

Errors are application/problem+json. Branch on code.

Status	Code	When
400	invalid_input	A field is missing or has the wrong format. `errors[]` points at each field.
401	unauthenticated	The Authorization header is missing, the key is unknown, expired or revoked.
403	entitlement_required	The workspace's plan does not include API access (`api_access`).
403	insufficient_scope	The key does not have the permission this operation needs.
429	rate_limited	The key or workspace went over its rate limit. Wait for `Retry-After` seconds.
503	upstream_unavailable	A service behind the API is briefly unavailable. Safe to retry with backoff.

Examples

WhatsApp numbers

Response 200

{
  "data": [
    {
      "id": "301",
      "name": "Main WhatsApp",
      "type": "whatsapp",
      "identifier": "+15555550100",
      "is_default": true,
      "status": "connected",
      "quality_rating": "GREEN",
      "meta_channel_id": null,
      "web_surface": null,
      "meta_phone_number_id": null,
      "payment_configuration": null
    }
  ],
  "next_cursor": null,
  "total": 1,
  "warnings": []
}

Operation path

The same operation is also at POST /v1/ops/workspace_channels, with every field in the JSON body.