Skip to main content
flag
Mon - Fri   10:00 – 18:00

List Numbers

API Documentation / WhatsApp / List Numbers

Base URL for your account: https://cpaas.studio

GET /api/whatsapp/v1/channels

Active, non-deleted WhatsApp numbers available for selection, with their uid, quality rating, messaging tier and status. A key restricted to one number sees only that one when active. Use number details to inspect a disabled number.

No parameters.

Request example

curl -X GET "https://cpaas.studio/api/whatsapp/v1/channels" \
  -H "X-API-KEY: cpk_xxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Success response (data)

{
    "channels": [
        {
            "uid": "WCH54DZ7M7M5V",
            "display_phone": "+919895000000",
            "verified_name": "Acme Stores",
            "route": "waba_cloud",
            "status": "active",
            "number_status": "connected",
            "quality_rating": "green",
            "messaging_tier": "TIER_10K",
            "mps_limit": 80,
            "profile": {},
            "created_at": "2026-10-07T10:00:00+00:00"
        }
    ],
    "pagination": {
        "page": 1,
        "per_page": 25,
        "total": 1,
        "total_pages": 1
    }
}

Need more context? See Getting started for authentication, the response envelope, and the full error-code reference.