GET
/
whatsapp

Authorizations

x-api-key
string
headerrequired

Query Parameters

phoneNumber
string
required

Phone number in international format (E.164)

retrieveIfDoesNotExists
boolean
default: falserequired

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

sentId
string | null

Optional Sent platform identifier for tracking

Response

200 - application/json

WhatsApp contact information including profile and verification details

id
string

Unique identifier for the phone number record

sentId
string

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