Skip to main content
GET
List customers

Authorizations

Authorization
string
header
required

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

Query Parameters

cursor
string

Opaque cursor returned in next_cursor.

limit
integer
default:50
Required range: 1 <= x <= 200
email
string

Case-insensitive exact match.

phone
string

Exact-string match (no E.164 normaliser in-tree yet).

externalRef
string

Match on the partner-supplied identifier you stored on create. Combine with email / phone for AND semantics.

card_serial
string

Resolve the customer from either the stable POS barcode now displayed on the pass or a legacy wallet-pass serial. Returns an empty list if the identifier doesn't match an active pass in this organization. POS adapters scanning the customer's pass at the till use this to look up the customer record before posting a transaction.

createdAfter
string<date-time>

Response

OK

has_more
boolean
required
next_cursor
string | null
required
limit
integer
required
data
object[]
required