List WhatsApp numbers

List the WhatsApp numbers connected to your organization, for example to pick the whatsapp_channel_id that starts a conversation.

Endpoint

GET
/whatsapp-channels

Query parameters

NameTypeRequiredDescription
organization_idintegerNoOrganization. Results are always limited to your API key's organization.
statusstringNoactive returns only numbers that can send. Also pending, inactive.
wa_ba_idstringNoNumbers of one WhatsApp Business Account.
$limit / $skipintegerNoPagination. Default 10, max 50.
$sort[id]1 | -1No1 lists the oldest first (the first active one is the default number).
$select[]stringNoe.g. $select[]=id&$select[]=label&$select[]=display_phone_number.

Request

Response

json

Each item is a full WhatsApp channel object (shortened here).

Notes

  • Members restricted to some channel accounts only see the numbers they have access to.

Report an issue with this documentation

Please log in to report issues with our documentation.