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 customer ID

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.

Response

200 - application/json
id
string
required

The id of the customer.

emailAddress
string
required

The primary email address of the customer.

firstName
string | null
required

The first name of the customer.

lastName
string | null
required

The last name of the customer.

phoneNumber
string | null
required

The phone number of the customer.

livemode
boolean
required

Wether the customer is in live mode or test mode.

isBlocked
boolean
required

Wether the customer is blocked or not.

organizationId
string
required

The id of the organization.

addressId
string | null
required

The id of the shippingAddress.

shippingAddressId
string | null
required

The id of the shippingAddress.

metadata
object | null
required

Additional metadata for the customer.

createdAt
string
required
createdBy
string | null
required

The id of the user who created the customer.

updatedAt
string
required
blockedAt
string | null
required
blockedBy
string | null
required

The id of the user who blocked the customer.

updatedBy
string | null
required

The id of the user who last updated the customer.

deletedAt
string | null
required
Create customerUpdate customer