Skip to main content
GET
Get a contact
external_id contains the contact’s ID in your system, or null when the contact was not identified by external ID. primary_external_id contains the main account’s external ID, or null when the contact has no main account reference. The referenced contact may not exist yet. This value is set through Authenticate contact by external ID; agents can view connected contact history in the dashboard, subject to their session permissions. Each contact retains its own sessions and customer access.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

contact_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Default Response

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
external_id
string | null
required

The contact's ID in your system, unique within your organization, or null when the contact was not identified by external ID. Set through external-ID widget authentication.

primary_external_id
string | null
required

The main account's external_id within your organization, or null when unlinked. The main contact may not exist yet. Set through external-ID widget authentication; contact create/update endpoints do not accept this field.

email
string<email> | null
required
Pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
phone_number
string | null
required
name
string | null
required
custom_data
object | null
required
non_verified_custom_data
object | null
required

Custom data from unverified sources (e.g. an unauthenticated widget visitor), kept apart from custom_data

created_at
string
required

ISO 8601 timestamp of when the contact was created

updated_at
string
required

ISO 8601 timestamp of when the contact was last updated