> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zixflow.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get WhatsApp Accounts

> Retrieves a list of all WhatsApp accounts for the authenticated workspace

#### 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

<ParamField header="x-api-key" type="string" required placeholder="Enter your API key">
  Your API key for authentication.
</ParamField>

<ParamField header="x-workspace-id" type="string" required placeholder="Enter your workspace ID">
  Your workspace ID for authentication.
</ParamField>

#### Response

<ResponseField name="success" type="boolean">
  Indicates whether the API call was successful.
</ResponseField>

<ResponseField name="message" type="string">
  Success or error message from the API.
</ResponseField>

<ResponseField name="data" type="array">
  An array of WhatsApp account objects, each containing:
</ResponseField>

<ResponseField name="data[].phone_id" type="string">
  The unique Phone ID associated with the WhatsApp Business account. Use this ID when sending messages.
</ResponseField>

<ResponseField name="data[].waba_id" type="string">
  The WhatsApp Business Account (WABA) ID.
</ResponseField>

<ResponseField name="data[].display_phone_number" type="string">
  The display phone number for this WhatsApp account.
</ResponseField>

<ResponseField name="data[].verified_name" type="string">
  The verified business name associated with this WhatsApp account.
</ResponseField>

<ResponseField name="data[].quality_rating" type="string">
  The quality rating of the WhatsApp account (e.g., "GREEN", "YELLOW", "RED").
</ResponseField>

<ResponseField name="data[].daily_limit" type="integer">
  The daily messaging limit for this WhatsApp account.
</ResponseField>

<ResponseExample>
  ```json 200-Success theme={null}
  {
    "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
      }
    ]
  }
  ```

  ```json 401-Unauthorized theme={null}
  {
    "success": false,
    "message": "Unauthorized. Please check your API key and workspace ID."
  }
  ```

  ```json 500-Internal Server Error theme={null}
  {
    "success": false,
    "message": "Internal server error. Please try again later."
  }
  ```
</ResponseExample>