Contacts

Get a contact's profile

Returns a contact's user info (status text, profile picture ID, linked devices, verified business name) and, when the contact is a WhatsApp Business account, its business profile. The contact is addressed with a jid (or number) query parameter, matching the GET /contacts/profile-picture convention.

GET
/contacts/profile

Returns a contact's user info (status text, profile picture ID, linked devices, verified business name) and, when the contact is a WhatsApp Business account, its business profile. The contact is addressed with a jid (or number) query parameter, matching the GET /contacts/profile-picture convention.

Authorization

bearerAuth
AuthorizationBearer <token>

Per-user API token (UUID v4) sent as Authorization: Bearer <token>. Identifies the tenant and user.

In: header

Query Parameters

jid?string

Contact JID. Either jid or number is required.

number?string

Phone number in international format. Used when jid is omitted.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/contacts/profile?jid=5511999999999%40s.whatsapp.net&number=5511999999999"
{  "success": true,  "data": {    "jid": "5511999999999@s.whatsapp.net",    "user_info": {      "Status": "Hey there! I am using WhatsApp.",      "PictureID": "1718000000",      "Devices": [        "5511999999999@s.whatsapp.net"      ],      "VerifiedName": null    },    "business_profile": null  }}
{  "success": false,  "error": "validation failed",  "error_code": "VALIDATION_ERROR",  "timestamp": "2026-06-15T12:00:00Z"}
{  "success": false,  "error": "validation failed",  "error_code": "VALIDATION_ERROR",  "timestamp": "2026-06-15T12:00:00Z"}
{  "success": false,  "error": "validation failed",  "error_code": "VALIDATION_ERROR",  "timestamp": "2026-06-15T12:00:00Z"}
{  "success": false,  "error": "validation failed",  "error_code": "VALIDATION_ERROR",  "timestamp": "2026-06-15T12:00:00Z"}
{  "success": false,  "error": "validation failed",  "error_code": "VALIDATION_ERROR",  "timestamp": "2026-06-15T12:00:00Z"}