Skip to main content
GET
List Whatsapp Numbers
number is what goes in an agent’s numbers.inbound_whatsapp - the number it ANSWERS on. phone_number_id is WhatsApp’s own id for the number, and nothing in an agent takes it.
Which number an agent sends a template from is set per template, in the dashboard. It is not part of the agent body here - see Changes.
Connecting a WhatsApp Business account is a dashboard action.

Authorizations

Authorization
string
header
required

Your API key as a Bearer token, e.g. Authorization: Bearer vk_….

Response

The workspace's connected WhatsApp numbers.

id
string
phone_number_id
string

WhatsApp's own id for this number. Which number an agent sends from is settled when the number is connected to it, so nothing takes this today.

number
string

E.164. What goes in numbers.inbound_whatsapp.

verified_name
string | null
status
string

Our connection state.

meta_status
string | null

What WhatsApp Manager shows. Published alongside status because a number can be live on one side and not the other.

assigned_agent_id
string | null

Which agent answers on it today, if any.