Skip to main content
GET
List customers
Without filters, this lists your active customers, oldest first, 50 at a time. Pass next_cursor back as cursor to get the next page. When next_cursor is null, you’ve reached the end. With email, it returns the active customer using that email, or an empty list. Archived customers aren’t included, since their email can be used for a new customer. URL-encode the email before you send it, since a + in an address is otherwise read as a space and the lookup comes back empty.

Authorizations

Authorization
string
header
required

An API key from Configure → API Keys (it starts with jz_live_), sent as a bearer token. See API Keys.

Query Parameters

email
string

Find the customer using this email. URL-encode it, since a + in an address is otherwise read as a space and the lookup comes back empty.

cursor
string

The next_cursor from the previous page.

Response

A page of customers.

data
Customer · object[]
next_cursor
string | null

Pass as cursor to get the next page. null on the last page.

version
enum<string>
Available options:
v1