List customers
GET
/v1/customers
Lists the active org's customer profiles. Each row includes the system fields plus a custom_fields map reflecting the per-tenant custom-field values. Returns up to 500 rows (no pagination in v1).
Authorizations
BearerAuth
API key in the form one_pk_<random>. Mint at /settings/api-keys.
Type
HTTP (bearer)
Parameters
Query Parameters
status
Filter by status. all returns every status; default is active.
Type
string
Valid values
"active""inactive""archived""all"fields
Comma-separated sparse fieldset. Supports id,name,custom_fields or custom_fields.<key>. Unknown keys are dropped silently.
Type
string
Responses
Array of customer-profile envelopes with total count.
application/json
JSON "meta": { "version": 0, "total": 0 }, "data": [ { "id": "string", "party_id": "string", "name": "string", "status": "string", "account_number": "string", "payment_terms": "string", "default_currency": "string", "credit_limit": "string", "billing_email": "string", "contact_first_name": "string", "contact_last_name": "string", "contact_email": "string", "contact_phone": "string", "notes": "string", "custom_fields": { "additionalProperties": null }, "created_at": "string", "updated_at": "string" } ]
{
}