Skip to main content
GET
https://api-ai.zixflow.com
/
api
/
data
/
whatsapp
/
v1
/
accounts
Get WhatsApp Accounts
curl --request GET \
  --url https://api-ai.zixflow.com/api/data/whatsapp/v1/accounts \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-workspace-id: <x-workspace-id>'
{
  "success": true,
  "message": "Successfully fetched WhatsApp accounts",
  "data": [
    {
      "phone_id": "123456789",
      "waba_id": "987654321",
      "display_phone_number": "+1 234 567 8900",
      "verified_name": "My Business",
      "quality_rating": "GREEN",
      "daily_limit": 1000
    },
    {
      "phone_id": "987654321",
      "waba_id": "987654321",
      "display_phone_number": "+1 234 567 8901",
      "verified_name": "Another Business",
      "quality_rating": "GREEN",
      "daily_limit": 500
    }
  ]
}

​
Description

This endpoint allows you to retrieve a list of all WhatsApp Business accounts associated with your workspace. Each account includes details such as phone ID, display phone number, verified name, quality rating, and daily limits.

​
Headers

​
x-api-key
string
required
Your API key for authentication.
​
x-workspace-id
string
required
Your workspace ID for authentication.

​
Response

​
success
boolean
Indicates whether the API call was successful.
​
message
string
Success or error message from the API.
​
data
array
An array of WhatsApp account objects, each containing:
​
data[].phone_id
string
The unique Phone ID associated with the WhatsApp Business account. Use this ID when sending messages.
​
data[].waba_id
string
The WhatsApp Business Account (WABA) ID.
​
data[].display_phone_number
string
The display phone number for this WhatsApp account.
​
data[].verified_name
string
The verified business name associated with this WhatsApp account.
​
data[].quality_rating
string
The quality rating of the WhatsApp account (e.g., “GREEN”, “YELLOW”, “RED”).
​
data[].daily_limit
integer
The daily messaging limit for this WhatsApp account.
{
  "success": true,
  "message": "Successfully fetched WhatsApp accounts",
  "data": [
    {
      "phone_id": "123456789",
      "waba_id": "987654321",
      "display_phone_number": "+1 234 567 8900",
      "verified_name": "My Business",
      "quality_rating": "GREEN",
      "daily_limit": 1000
    },
    {
      "phone_id": "987654321",
      "waba_id": "987654321",
      "display_phone_number": "+1 234 567 8901",
      "verified_name": "Another Business",
      "quality_rating": "GREEN",
      "daily_limit": 500
    }
  ]
}