List customers
List customers, keyset-paginated. Covers every organization your credential can access; pass an Organization-Id, Connection-Id or Entity-Id selector to narrow to one. Pass limit and the opaque cursor from a prior response's nextCursor or previousCursor to page; Archived customers are excluded. hasMore and hasPrevious report whether a page exists that way. A cursor is only valid for the sort, the filters AND the organization scope it was issued under, including any selector header: change any of them and start again from the first page.
Authorization
Headers
Release date, as YYYY-MM-DD. Defaults to 2026-07-21.
Narrow the request to one organization (Organization-Id selector).
Narrow the request to a connection's organization.
Narrow the request to a platform entity's organization.
Optional source to disambiguate an Entity-Id.
Query
Every query parameter below is optional. Combine as many as you need and append them to the endpoint as a query string. The example shows a few to get you started.
/customers?sort=<sort>&order=<order>&search=<search>Field to sort by. createdAt is the default and is dramatically faster on large organizations; the other keys sort the whole matching set.
createdAtnamestreet1citystatepostalCodecountrystatusSort direction. Defaults to desc, so newest first.
ascdescSearch over customer id, name, email, externalId and externalFriendlyId. id, externalId and externalFriendlyId must match exactly; name and email match a case-insensitive substring.
Comma-separated ISO 3166-1 alpha-2 country codes; matches any of them.
Comma-separated state or province codes; matches any of them.
Comma-separated source systems; matches any of them.
Comma-separated connection ids; matches any of them. This filters rows by connection. To restrict which organization is read, send the Connection-Id header instead.
Maximum number of items to return.
Opaque cursor from a prior response's nextCursor or previousCursor. Omit for the first page.
Response
The customers on this page.
Opaque cursor for the next page, or null on the last page. Pass it back as cursor.
Opaque cursor for the previous page, or null on the first page. Pass it back as cursor.
Whether a page exists after this one.
Whether a page exists before this one.
Successful Response
The request was invalid.
Authentication failed or was missing.
The credential is not permitted for this request.
The requested resource was not found.
The request conflicts with existing state.
The request failed validation.