GET
/
customers
/
{id}

Authorizations

Authorization
string
headerrequired

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

Path Parameters

id
string
required

Unique identifier of the customer to fetch

Query Parameters

expand
string[]

Fields to expand related entities. For example, ["organization"].

take
number

Maximum number of items to retrieve. Default is 25.

skip
number

Number of items to skip before starting to collect the result set.

orderBy
string

Field to order the results by, followed by ":asc" or ":desc". For example, "createdAt:desc".

search
string

Search term to filter the results. Supports multiple terms with "~" for partial matches.

Query parameters for additional filtering, sorting, and expansion.

Response

200 - application/json
emailAddress
string
required

The primary email address of the customer.

firstName
string | null

The first name of the customer.

lastName
string | null

The last name of the customer.

phoneNumber
string | null

The phone number of the customer. Must include the country code.

address
object

The address of the customer.

shippingAddress
object

The shipping address of the customer.

metadata
object

Additional metadata for the customer.

locale
enum<string>

The locale preference of the customer.

Available options:
en_US,
fr_FR
clientReferenceId
string

Unique string of your choice to reconcile with your internal system.