Skip to main content
GET
Get Whatsapp Account

Headers

x-api-key
string | null

Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.

Path Parameters

phone_number_id
string
required

Response

Successful Response

business_account_id
string
required
phone_number_id
string
required
business_account_name
string
required
phone_number_name
string
required
phone_number
string
required
assigned_agent_name
string | null
required
registration_status
enum<string>
required
Available options:
UNKNOWN,
REGISTERING,
REGISTERED,
UNCERTAIN,
ACTION_REQUIRED
account_type
string
default:cloud_api

Which Embedded Signup flow produced this account.

Allowed value: "cloud_api"
assigned_agent_id
string | null
enable_messaging
boolean
default:true
enable_audio_message_response
boolean
default:true
enable_typing_indicator
boolean
default:true
is_token_expired
boolean
default:false