GET
/
whatsapp
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "sentId": "123e4567-e89b-12d3-a456-426614174111",
  "phoneNumber": "+14155552671",
  "whatsappId": "14155552671",
  "countryCode": "US",
  "numberType": "MOBILE",
  "profilePicture": "https://profile.whatsapp.com/photo.jpg",
  "isBusiness": false,
  "invalidRecord": false,
  "createdAt": "2023-01-01T12:00:00Z",
  "updatedAt": "2023-01-01T12:00:00Z"
}

Authorizations

x-api-key
string
header
required

Query Parameters

phoneNumber
string
required

Phone number in international format (E.164)

Example:

"+14155552671"

retrieveIfDoesNotExists
boolean
default:false
required

Whether to create a new contact if one doesn't exist

sentId
string | null

Optional Sent platform identifier for tracking

Response

200
application/json
Successfully retrieved WhatsApp contact information

WhatsApp contact information including profile and verification details