Get customer
Returns the info about the customer with a given id.
customers:roAuthorizations
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.
Scopes
Body
The customer ID.
Response
Returns the customer object.
The customer ID.
The customer type. Always customer.
The customer's name. Returned only if set.
The customer's email. Returned only if set.
The email address suggested for the customer based on tracked activity, such as a form submission. The customer has not confirmed this address. This field is independent of email and is not used for identity merging or segment membership, including built-in lead segments. Returned only if set.
The customer's avatar. Returned only if set.
The customer's phone number. Returned only if set.
The date and time when the customer's identity was created.
An array of custom object-enclosed key-value pairs. Returned only if set. Available for the session duration.
Counters for started threads, opened pages, etc.
Geolocation and opened pages from the customer's most recent online visit. Returned only if the customer logged in at least once.
The IDs of the customer's chats. Returned only if the customer had at least one chat.
The customer's identities on supported messaging channels.
The customer's address data. Returned only if set.
An object where the keys are the IDs of the customer's properties and the values are their data.
The date and time of the last event created by an agent in this customer's chats.
The date and time of the last event created by the customer.
The customer's relationship level. Returned only if set.
vip The ID shared by the customer records that the Customer Data Platform merges into a single customer. For every customer record in the resulting group, the value is the master customer's id. A customer record that the Customer Data Platform has not merged with another record uses its own customer id. The value can change when customers are merged or unmerged, so do not use it as a permanent identifier for a person. Agent Chat API methods do not accept cluster_id as a customer ID. Returned when Customer Data Platform data is available for the customer.
The customer's segment memberships. Returned only if set.