Skip to main content
GET
/
{phone_number_id}
/
username
Get current username
curl --request GET \
  --url https://api.kapso.ai/meta/whatsapp/v24.0/{phone_number_id}/username \
  --header 'X-API-Key: <api-key>'
{
  "username": "kapso_support",
  "status": "reserved"
}

Authorizations

​
X-API-Key
string
header
required

Project API key for authentication. This is the recommended authentication method.

Get your API key from the Kapso dashboard under Integrations > API keys.

Path Parameters

​
phone_number_id
string
required

WhatsApp Business Phone Number ID

Response

Current username state

​
username
string

Current business username. Omitted when none exists.

Example:

"kapso_support"

​
status
enum<string>
Available options:
approved,
reserved
Example:

"reserved"