v51

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-02172186551.1 KB

Get contact by phone number

get/v1/contacts/phone/{phoneNumber}

Path parameters

phoneNumberstring required

E.164 phone number.

Response

Contact details.

idstring required

displayNamestring

Display name for the contact.

phoneNumberstring

DEPRECATED: Use primaryPhone instead. Primary phone number in E.164 format.

primaryPhonestring

Primary phone number in E.164 format.

primaryEmailstring email

Primary email address.

countryCodestring

profileNamestring nullable

Contact's WhatsApp profile name. Only available for WhatsApp contacts.

availableChannelsstring[] required

List of available messaging channels for this contact.

Preferred channel for this contact.

verifiedboolean required

Whether this contact has been verified.

suggestedMergeWithstring

ID of a contact suggested for merging.

metadataobject required

createdAtstring date-time required

updatedAtstring date-time

Example response

{
  "displayName": "John Doe",
  "phoneNumber": "+56912345678",
  "primaryPhone": "+56912345678",
  "primaryEmail": "john@example.com",
  "countryCode": "CL",
  "profileName": "John Doe",
  "channels": [
    {
      "identifier": "+14155551234",
      "countryCode": "US",
      "label": "work"
    }
  ]
}