Skip to main content
GET
List the customers linked to the calling app

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
limit
integer
default:100

1-500, default 100. A value above 500 is 400 too_big; a negative value reads 1, and 0 or a non-number reads 100.

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

The opaque meta.nextCursor from the previous page.

Minimum string length: 1

Response

One page of the linked customers

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.