Customers

The Customers API allows you to retrieve customer records linked to your integration via two endpoints:

  • One for retrieving details for a specific customer.

  • One for retrieving a paginated list of customers.

Retrieve a paginated list of customers

get
/api/v1/customers

Returns a list of customers, paginated according to the 'per_page' and 'page' query parameters.

Authorizations
AuthorizationstringRequired

Authentication using a Bearer token.

Query parameters
per_pageinteger · min: 1 · max: 100Optional

Number of items to return per page in a paginated response.

Default: 15
pageinteger · min: 1Optional

The current page number for paginated results.

Default: 1
Responses
200

A paginated array of customer resources

application/json
get
/api/v1/customers

Retrieve details for a specific customer

get
/api/v1/customers/{uuid}

Returns comprehensive information about a customer identified by their unique UUID.

Authorizations
AuthorizationstringRequired

Authentication using a Bearer token.

Path parameters
uuidstring · uuidRequired

Universally Unique Identifier (UUID) as defined by RFC 4122.

Example: e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2gPattern: ^[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12}$
Responses
200

Detailed information about the requested customer.

application/json
get
/api/v1/customers/{uuid}

Last updated

Was this helpful?