ZAzavudev

Get contact

Changed on
get/v1/contacts/{contactId}

Request

  • Base URL
    https://api.zavu.dev
  • URL
    https://api.zavu.dev/v1/contacts/{contactId}
  • Auth
    HTTP bearer

Path parameters

contactIdstring required

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.

defaultChannel'sms' | 'whatsapp' | 'telegram' | 'email' | 'instagram' | 'messenger' | 'voice'

Preferred channel for this contact.

verifiedboolean required

Whether this contact has been verified.

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",
  "whatsapp": {
    "bsuid": "CO.13491208655302741918"
  },
  "channels": [
    {
      "identifier": "+14155551234",
      "countryCode": "US",
      "label": "work"
    }
  ]
}

Changes