Skip to main content
GET
List the organization's customers
Returns the organization’s customers, oldest first by creation time. limit defaults to 50 and reads at most 100 customers per page. Each page reads its limit customers before status and customerType apply, so a filtered page may hold fewer customers than limit, or none, while meta.hasMore is true. Pass meta.nextCursor back as cursor while meta.hasMore is true; a walk whose last page was exactly full ends with one empty page. count is the number of customers on this page. A repeated parameter, an invalid status or customerType, a limit that is not a positive integer, or a malformed cursor is 400 bad_request. The credential needs customers:read granted at the deployment root; a grant held only below it is 403 permission_denied.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Query Parameters

status
enum<string>
Available options:
active,
inactive,
archived
customerType
enum<string>

org for businesses and organizations, user for individuals.

Available options:
org,
user
limit
integer
default:50

Customers read per page, 1-100, default 50. A value above 100 is 400 too_big.

Required range: 1 <= x <= 100
cursor
string

The opaque meta.nextCursor from the previous page.

Minimum string length: 1

Response

One page of the customer directory

data
object
required
meta
object
required

A list page's continuation. While hasMore is true, nextCursor is a string: pass it as cursor for the next page. hasMore: false ends the list; with truncated: true, more exist past what this list reads, and no cursor reaches them.