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
| Name | Type | Required | Description |
|---|---|---|---|
organization_id | integer | No | Organization. Results are always limited to your API key's organization. |
status | string | No | active returns only numbers that can send. Also pending, inactive. |
wa_ba_id | string | No | Numbers of one WhatsApp Business Account. |
$limit / $skip | integer | No | Pagination. Default 10, max 50. |
$sort[id] | 1 | -1 | No | 1 lists the oldest first (the first active one is the default number). |
$select[] | string | No | e.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.