WhatsApp agentsWhatsApp accounts
List accounts
Returns the WhatsApp numbers connected to your workspace.
GET
/v2/whatsapp/accountsAuthorization
AuthorizationstringheaderrequiredBearer authentication header of the form
Bearer <api_key>, where<api_key>is a key from Account Settings → API keys in your dashboard.
Response
An array of WhatsApp account objects.
idstring (uuid)WhatsApp account id.
waba_idstringMeta WhatsApp Business Account id.
phone_number_idstringMeta phone number id. Use it as an agent's
set_inbound_whatsapp_number.display_e164stringnullableThe number in E.164 format.
statusstringConnection status, e.g.
active.modestringcloud_apiorcoexistence(number also used in the WhatsApp Business app).Allowed:cloud_apicoexistencecreated_atstring (date-time)nullableWhen the number was connected.
updated_atstring (date-time)nullableWhen it was last changed.