Get WhatsApp Senders

List all WhatsApp Business senders for the authenticated user

Updated 15 Aug 2026

On this page

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

statusstring

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

Response Fields

dataarray

idinteger

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

phone_numberstring

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

display_namestring

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

statusstring

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

quality_ratingstring

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

messaging_limitinteger

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

messaging_limit_formattedstring

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

voice_calling_enabledboolean

  `true` when WhatsApp Calling is enabled on this sender. See [WhatsApp Calling](/whatsapp/calling).

curl -X GET "https://app.voxlink.ai/api/user/whatsapp/senders" \
  -H "Authorization: Bearer YOUR_API_KEY"

curl -X GET "https://app.voxlink.ai/api/user/whatsapp/senders?status=all" \
  -H "Authorization: Bearer YOUR_API_KEY"

const response = await fetch(
  'https://app.voxlink.ai/api/user/whatsapp/senders',
  {
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  }
);

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

import requests

response = requests.get(
    'https://app.voxlink.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']}")

{
  "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",
      "voice_calling_enabled": true
    },
    {
      "id": 15,
      "phone_number": "+442071234567",
      "display_name": "Acme Corp Sales",
      "status": "online",
      "quality_rating": "GREEN",
      "messaging_limit": null,
      "messaging_limit_formatted": "Unlimited",
      "voice_calling_enabled": false
    }
  ]
}

{
  "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.

Related guides

API Reference

Introduction

Welcome to the VoxLink API

Read guide →

API Reference

Authentication

Learn how to authenticate your API requests

Read guide →

API Reference

Get current user

Get the authenticated user's profile information

Read guide →

API Reference

List assistants

List all assistants for the authenticated user with pagination

Read guide →