Skip to navigation

List partner customers

List partner customers.

Credential: Partner secret

Before you call

  • A server-side partner secret for the owning partner. Do not send an Origin header.

Lists only customers of

the authenticated partner, across its integrations. Each page scans at most

100 profiles plus one lookahead; deleted and malformed profiles are omitted.

A page can be empty and still have a nextCursor. Follow nextCursor until null.

Returns directory names and stable partner customer IDs, without contacts,

wallet addresses, sessions, or payment data. Requires no customer session.

Confirm with Sinbad that this endpoint is enabled in your environment.

Errors

StatusCodeWhat to do
400VALIDATION_ERRORCorrect the fields reported in details before retrying.
401UNAUTHENTICATEDCreate a new customer session or use a valid server credential.
403FORBIDDENCheck credential ownership, integration and the supplied Origin.
503UPSTREAM_ERRORRetry with backoff; preserve the same idempotency key for a repeated mutation.

Authentication

AuthorizationBearer

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

Query parameters

afterstringOptionalformat: "^[a-zA-Z0-9_-]{1,128}$"

nextCursor from the preceding page; omit for the first page.

Response

One bounded page of partner customers
userslist of objects
nextCursorstring or null

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
503
Service Unavailable Error