Skip to main content
GET
/
whatsapp
Retrieve WhatsApp contact information
curl --request GET \
  --url https://api.example.com/whatsapp \
  --header 'x-api-key: <api-key>'
{
  "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<uuid> | null

Optional Sent platform identifier for tracking

Response

Successfully retrieved WhatsApp contact information

WhatsApp contact information including profile and verification details

​
id
string<uuid>

Unique identifier for the phone number record

​
sentId
string<uuid>

Sent platform identifier

​
phoneNumber
string

Phone number in E.164 format

​
whatsappId
string

Unique WhatsApp identifier for the contact

​
countryCode
string

ISO country code of the phone number

​
numberType
enum<string>

Type of phone number (MOBILE, LANDLINE, etc)

Available options:
MOBILE,
LANDLINE,
VOIP,
UNKNOWN
​
profilePicture
string

URL to the contact's WhatsApp profile picture

​
isBusiness
boolean

Indicates if the number belongs to a WhatsApp Business account

​
invalidRecord
boolean

Indicates if the WhatsApp account is invalid or deactivated