Find all Customers

GET 
/v2/customers

Retrieve a paginated list of Customers

Request

Responses

200

OK

202

The merchant is entitled but its environment is not provisioned yet. Provisioning has been kicked off (exactly once) and is in progress; retry the request — it succeeds once the environment is ready. Returned only for identity-token (dashboard) requests bound to a merchant, not for secret-key API calls; any such endpoint can return it while provisioning is underway.

400

The request was rejected. type is invalid_request_error when the request itself is at fault — errors then lists every problem found, with field-attributable entries prefixed by the field’s path; or invalid_state_error when the request was well-formed but the resource is not in a state that allows it.

401

No API key was supplied, or the key is not valid. type is authentication_error.

403

The API key is valid but lacks the permission this operation requires. type is permission_error.

429

Too many requests. A limit applies per operation; requests to other operations are unaffected. type is rate_limit_error. Use the Retry-After-global header to know when to retry.

Response Headers

Retry-After-global

Seconds to wait before retrying.

500

The request could not be completed because of an unexpected error. type is api_error.

503

The request could not be served right now: the API is temporarily at capacity, or a dependency needed to authorize the request is unavailable — the auth service that verifies credentials, or the entitlement lookup behind it. type is api_error. It is raised before the operation runs, so the request had no effect, and unlike a plain 500 the condition is transient: retry with backoff.

504

The request exceeded the processing time limit and was abandoned. type is api_error and code is timeout — unlike a plain 500 the request may still have taken effect, so retry with the same idempotency key rather than blindly.