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
customer_id
string<uuid>
required

The requested customer ID.

Response

Customer data.

customer_id
string<uuid>
required
organization_id
string<uuid>
required
product
string
required
Example:

"livechat"

monitoring
object | null
required

The customer's profile and website activity collected by Text.

custom_fields
object | null
required

The object groups custom fields about the customer by the client ID of the app that set their values. You can retrieve but not modify these fields with the Customer Data Platform API. Unlike customer_properties, custom_fields do not have predefined types and cannot be used to filter customers.

statistics
object | null
required
chat
object
invitation
object
customer_properties
object

A map of customer property definition IDs to their current values. You can use these properties to filter customers. The field is omitted when the customer has no property values.

In Text interfaces, customer properties are labeled customer fields.

tickets
object
omnichannel
object
orders
object[]
carts
object[]
segment_memberships
object[]

The customer's membership state for each segment that has been evaluated for the customer.

relationship_level
enum<string> | null

The relationship level. Omitted when no relationship level is assigned.

Available options:
vip
opt_ins
object

Marketing consents granted by the customer, keyed by channel (sms, whatsapp, messenger, or instagram). Only consents valid at the time of the request are returned. A channel with no valid consents is omitted, and the field is omitted when the customer has no valid consents.