Get all customers
Retrieve a list of customers (Finix identities) for the authenticated company. Filters: `role` (one of APPLICATION_OWNER, BENEFICIAL_OWNER, BUYER, PLATFORM_OWNER, RECIPIENT, SELLER, SENDER — values match the `finix_identity_role` DB enum); `include=instruments` (joins payment_instruments); `include_hidden=true` (returns identities tagged `hidden=true` — suppressed by default).
Authorization
apiKey Merchant API key. Publishable keys (pk_test_* / pk_live_) are safe for browser/frontend use and carry a limited scope set (sessions, payment_instruments, customers, orders writes; products, product_prices, payment_links reads). Secret keys (sk_test_ / sk_live_*) grant full admin access and must only be used server-side.
In: header
Query Parameters
0 <= value0 <= value"APPLICATION_OWNER" | "BENEFICIAL_OWNER" | "BUYER" | "PLATFORM_OWNER" | "RECIPIENT" | "SELLER" | "SENDER""instruments""true" | "false"Response Body
application/json
application/json
application/json
curl -X GET "https://loading/v1/api/customer/"{
"success": true,
"timestamp": "2026-02-06T12:00:00.000Z",
"data": [
{
"id": "IDxxxxxxxxxxxxxxxxxx",
"entity": {
"first_name": "John",
"last_name": "Doe",
"email": "john@example.com"
},
"tags": {
"company_id": "comp_abc123"
},
"company_id": "comp_abc123",
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-15T00:00:00.000Z"
}
]
}{
"success": false,
"timestamp": "2019-08-24T14:15:22Z",
"error": {
"code": "string",
"message": "string",
"details": null
}
}{
"success": false,
"timestamp": "2019-08-24T14:15:22Z",
"error": {
"code": "string",
"message": "string",
"details": null
}
}