Get all clients

Retrieve all clients

Returns an ARRAY of clients visible to the caller. Requires the client/read, client/write, administrator/read or administrator/write scope. Results are scoped by matching the x-client-id header value against the client's external_id. A missing or unresolvable x-client-id is rejected with 403 and an EMPTY body before this handler runs.

Responses

🟢200OK

application/json

Bodyapplication/json

Example

{
    "id": "50e748c1-ebf9-449c-ab3f-2744323753d3",
    "name": "Ms. Terry Olson",
    "email": "Zoila.Murphy@yahoo.com",
    "status": "INACTIVE",
    "created_at": "2025-01-14T16:31:18.487Z",
    "updated_at": "2025-01-14T16:31:18.488Z",
    "metadata": {},
    "external_id": null,
    "fees_paid_by": null,
    "client_wallet_id": null
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Get all clients

Request

Request Code Samples

Responses