Skip to main content
POST
Get customer
Required scopes: customers:ro

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
id
string
required

The customer ID.

Response

200 - application/json

Returns the customer object.

id
string

The customer ID.

type
string

The customer type. Always customer.

name
string

The customer's name. Returned only if set.

email
string

The customer's email. Returned only if set.

avatar
string

The customer's avatar. Returned only if set.

phone_number
string

The customer's phone number. Returned only if set.

created_at
string

The date and time when the customer's identity was created.

session_fields
object[]

An array of custom object-enclosed key-value pairs. Returned only if set. Available for the session duration.

statistics
object

Counters for started threads, opened pages, etc.

visit
object

Geolocation and opened pages from the customer's most recent online visit. Returned only if the customer logged in at least once.

chat_ids
string[]

The IDs of the customer's chats. Returned only if the customer had at least one chat.

omnichannel
object

The customer's omnichannel data.

address
object

The customer's address data. Returned only if set.

customer_properties
object

An object where the keys are the IDs of the customer's properties and the values are their data.

agent_last_event_created_at
string

The date and time of the last event created by an agent in this customer's chats.

customer_last_event_created_at
string

The date and time of the last event created by the customer.