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

# Get WhatsApp Senders

> List all WhatsApp Business senders for the authenticated user

This endpoint returns a list of WhatsApp Business senders (phone numbers) configured for your account. Use this to retrieve sender IDs needed for sending messages.

### Query Parameters

**status** `string`

Filter senders by status. Default: `online`. Use `all` to return all senders regardless of status.

### Response Fields

**data** `array`

**Sender object properties**

**id** `integer`

The unique identifier of the WhatsApp sender. Use this ID when sending messages.

**phone\_number** `string`

The sender's phone number in E.164 format (e.g., `+14155551234`)

**display\_name** `string`

The WhatsApp Business display name (business name shown to recipients)

**status** `string`

The sender's current status: `online` or `offline`

**quality\_rating** `string`

Meta's quality rating for this sender: `GREEN`, `YELLOW`, or `RED`

**messaging\_limit** `integer`

The current messaging limit (number of unique recipients per 24 hours). `null` means unlimited.

**messaging\_limit\_formatted** `string`

Human-readable messaging limit (e.g., `1,000 / 24hr`, `10,000 / 24hr`, or `Unlimited`)

```bash cURL theme={null}
curl -X GET "https://app.lacy.ai/api/user/whatsapp/senders" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```bash Filter all senders theme={null}
curl -X GET "https://app.lacy.ai/api/user/whatsapp/senders?status=all" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

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

const data = await response.json();
console.log(data.data); // Array of senders
```

```python Python theme={null}
import requests

response = requests.get(
    'https://app.lacy.ai/api/user/whatsapp/senders',
    headers={'Authorization': 'Bearer YOUR_API_KEY'}
)

senders = response.json()['data']
for sender in senders:
    print(f"{sender['display_name']}: {sender['phone_number']}")
```

```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"
    }
  ]
}
```

```json 200 Empty Response theme={null}
{
  "data": []
}
```

### Notes

* Only senders with status `online` are returned by default. Use `?status=all` to include offline senders.
* Sender status is synced with Meta every 5 minutes automatically.
* The `id` field is what you need to pass as `sender_id` when sending messages.
* Quality rating affects your messaging limits. A `RED` rating may restrict your ability to send messages.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.