Skip to main content
GET
Get contact by ID

Authorizations

Authorization
string
header
required

JWT authentication token

Headers

x-company-id
string

Target company identifier. Required only for global API keys (type=global). Ignored for company API keys and human users.

Path Parameters

id
string
required

Contact ID

Response

Contact found successfully

name
string
required

Contact name

company
any
required

Contact's company

_id
string

Contact ID

id
string

Contact ID (same value as _id)

country_code
string

Country code of the number. Absent, along with the phone, when the contact only has a WhatsApp identifier.

email
string

Contact's email

last_activity_at
any

Date of the contact's last activity

phone_number
string

The contact's phone number. Absent when the contact only has a WhatsApp identifier.

linkedin_identifier
string

LinkedIn profile identifier

job_title
string

Contact's job title

seniority
string

Contact's seniority level

department
string

Contact's department

country
string

Contact's country

region
string

Contact's state or region

city
string

Contact's city

experience
string

Contact's professional experience

skills
string

Contact's skills

additional_attributes
object

Values of the contact's custom fields, by slug. When saved via additional_attributes, the value comes in the envelope { id, value, type, updatedAt }. When saved via custom_fields (PUT), it comes raw: the option_id (select), the list of option_id (multi_select) or the text (text).

business
string | null

ID of the Business the contact belongs to

notes
object[]

Notes recorded on the contact

marketing_opt_out
object

Marketing opt-out per communication channel (whatsapp, email, linkedin). Absent or empty when the contact hasn't opted out of any channel.

whatsapp_user_id
string

The contact's WhatsApp identifier (BSUID), assigned by Meta. Opaque string.

whatsapp_username
string

The contact's WhatsApp @username, as Meta sends it

whatsapp_parent_user_id
string

The contact's WhatsApp parent_user_id, as Meta sends it

createdAt
any

Contact creation date

updatedAt
any

Contact update date