Skip to main content
GET
List customers for this partner tenant

Authorizations

X-API-Key
string
header
required

Partner API key. Sandbox keys start with is_test_; production keys start with is_live_. Keys are not interchangeable across environments. Send on every request. Never expose in browser or mobile clients.

Query Parameters

status
string | null

Optional status filter (e.g. incomplete, pending_review)

partner_customer_ref
string | null

Filter to a single customer by your partner_customer_ref

Example:

"partner-cust-001"

limit
integer
default:50
Required range: 1 <= x <= 100

Response

Customer list or ref lookup result. With partner_customer_ref: zero or one full vault row. Without it: up to limit summary rows (newest first). limit is ignored when partner_customer_ref is set.

status
enum<string>
required
Available options:
success
message
string
required
Example:

"Customers"

data
PartnerCustomerListData · object
required