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

# Get senders

> List your WhatsApp Business sender accounts.

Returns a list of WhatsApp Business senders (phone numbers) configured for your account. Use the sender `id` when sending messages.

## Endpoint

`GET /user/whatsapp/senders`

## Query parameters

<ParamField query="status" type="string" default="online">
  Filter senders by status. Use `all` to return senders regardless of status. Default: `online`.
</ParamField>

## Response

<ResponseField name="data" type="array">
  Array of WhatsApp sender objects.

  <Expandable title="Sender properties">
    <ResponseField name="id" type="integer">Unique identifier of the sender. Pass this as `sender_id` when sending messages.</ResponseField>
    <ResponseField name="phone_number" type="string">Sender's phone number in E.164 format.</ResponseField>
    <ResponseField name="display_name" type="string">WhatsApp Business display name shown to recipients.</ResponseField>
    <ResponseField name="status" type="string">Current status: `online` or `offline`.</ResponseField>
    <ResponseField name="quality_rating" type="string">Meta quality rating: `GREEN`, `YELLOW`, or `RED`.</ResponseField>
    <ResponseField name="messaging_limit" type="integer">Maximum unique recipients per 24 hours. `null` means unlimited.</ResponseField>
    <ResponseField name="messaging_limit_formatted" type="string">Human-readable messaging limit (e.g., `10,000 / 24hr`, `Unlimited`).</ResponseField>
  </Expandable>
</ResponseField>

## Example

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "https://portal.intellixent.ai/api/user/whatsapp/senders" \
    -H "Authorization: Bearer YOUR_API_KEY"
  ```

  ```javascript Node.js theme={null}
  const response = await fetch('https://portal.intellixent.ai/api/user/whatsapp/senders', {
    headers: { 'Authorization': 'Bearer YOUR_API_KEY' }
  });

  const data = await response.json();
  const senders = data.data;
  ```
</CodeGroup>

```json 200 Response theme={null}
{
  "data": [
    {
      "id": 12,
      "phone_number": "+14155551234",
      "display_name": "Acme Corp Support",
      "status": "online",
      "quality_rating": "GREEN",
      "messaging_limit": 10000,
      "messaging_limit_formatted": "10,000 / 24hr"
    },
    {
      "id": 15,
      "phone_number": "+442071234567",
      "display_name": "Acme Corp Sales",
      "status": "online",
      "quality_rating": "GREEN",
      "messaging_limit": null,
      "messaging_limit_formatted": "Unlimited"
    }
  ]
}
```

<Note>
  Only `online` senders are returned by default. Use `?status=all` to include offline senders. Sender status is synced with Meta every 5 minutes.
</Note>