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

Get Contact

API Documentation / WhatsApp / Get Contact

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

GET /api/whatsapp/v1/contacts/{phone}

One contact, addressed by phone. Add ?channel={uid} when the number is a contact on several of your numbers.

No parameters.

Request example

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

Success response (data)

{
    "contact": {
        "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"
    }
}

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