Skip to main content
GET
Retrieve a contact

Authorizations

Authorization
string
header
required

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

Path Parameters

contactId
string
required

Unique identifier of the contact

Example:

"contact_1234567890"

Response

Successfully retrieved contact details

id
string
Example:

"contact_1234567890"

chatSource
string | null
Example:

"website"

email
string | null
Example:

"john@example.com"

agentId
string
Example:

"clx1234567890abcdef"

distinctId
string | null
Example:

"user_12345"

name
string | null
Example:

"John Doe"

phone
string | null
Example:

"+1234567890"

threadId
string | null
Example:

"thread_12345"

ip
string | null
Example:

"192.168.1.1"

country
string | null
Example:

"US"

attributes
object[]
createdAt
string<date-time>
Example:

"2024-01-15T10:30:00Z"

updatedAt
string<date-time>
Example:

"2024-01-20T14:45:00Z"