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

List Contacts

API Documentation / WhatsApp / List Contacts

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

GET /api/whatsapp/v1/contacts

Your contacts.

Parameters

Param Type Required Notes
channel string no
group string no Group uid.
phone string no

Request example

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

Success response (data)

{
    "contacts": [
        {
            "phone": "+919876543210",
            "channel": "WCH54DZ7M7M5V",
            "username": null,
            "name": "Asha",
            "profile_name": "Asha K",
            "attributes": {
                "city": "Kochi"
            },
            "optout": null,
            "inactive": false,
            "consent_source": "website_form",
            "consent_at": "2026-10-09T10:00:00+00:00",
            "created_via": "api",
            "created_at": "2026-10-09T10:00:00+00:00"
        }
    ],
    "pagination": {
        "page": 1,
        "per_page": 50,
        "total": 1,
        "total_pages": 1
    }
}

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