Skip to main content
GET
/
v1
/
customers
List
curl --request GET \
  --url https://{defaultHost}/v1/customers \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/customers"
  },
  "data": [
    {
      "id": "aea58038-19d8-4072-875c-10a598b17774",
      "object": "customer",
      "affiliation_expires_at": null,
      "billing_matches_shipping": true,
      "email": "[email protected]",
      "first_name": null,
      "indexed": true,
      "last_name": null,
      "live_mode": true,
      "name": null,
      "phone": null,
      "unsubscribed": false,
      "tax_enabled": true,
      "portal_url": "http://app.example.com/portal_redirect/customers/aea58038-19d8-4072-875c-10a598b17774",
      "affiliation": null,
      "billing_address": "17c761ea-d794-47b4-8422-23c0a8d54cbe",
      "default_payment_method": null,
      "shipping_address": null,
      "tax_identifier": null,
      "created_at": 1767909690,
      "updated_at": 1767909690
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
email
string

Only return objects with the given email.

​
ids[]
string[]

Only return objects with the given IDs.

​
license_ids[]
string[]

Only return objects that belong to the given licenses.

​
limit
integer

A limit on the number of items to be returned, between 1 and 100.

​
live_mode
boolean

Only return objects that are live mode or test mode.

​
page
integer

The page of items you want returned.

​
query
string

The query to be used for full text search of this collection.

​
sort
string

The sorting column and order to be used for this collection. Available sorting columns for this endpoint are created_at, email, name, and updated_at.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
pagination
object
​
data
array

An array of objects.