Skip to main content
POST
Get customer

Authorizations

Authorization
string
header
required

Customer access token obtained from the customer authorization flow.

Query Parameters

organization_id
string
required

Unique identifier of the organization.

Body

application/json

The body is of type object.

Response

200 - application/json

Customer info.

id
string
type
string
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.

session_fields
object[]

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

omnichannel
object

An object of the customer's omnichannel data.

address
object

An object of the customer's address data. Returned only if set.