API referenceWhatsapp users
GET
/whatsapp/api/v1/users/{identifier}

A phone number, a phone JID or a LID. 404 when it is not on WhatsApp. Each check of a phone counts in the daily checks cap; the answer is kept a week.

Authorization

X-API-KEY<token>

Your API key from the console (gw_live_…).

In: header

Path Parameters

identifier*string

The person to look up: a phone number in international format (6 to 15 digits; +, 00, spaces and dashes are accepted), a phone JID (33612345678@s.whatsapp.net) or a LID (…@lid). Up to 64 characters; anything else answers 400.

Query Parameters

account_id*string

The WhatsApp account (wa_…).

Lengthlength <= 80

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/whatsapp/api/v1/users/33612345678?account_id=wa_Xk2pQ9rT4vW8yZ1a"
{  "object": "UserProfile",  "provider": "WHATSAPP",  "id": "123456789012399@lid",  "name": "Jane Doe",  "phone_number": "33612345678",  "is_business": false}