v1

latestOpenAPI 3.0.32026-07-2650226215.9 KB

Customers

List customers

Returns a paginated list of customers under the current Project.

get/customers

Query parameters

status'active' | 'inactive'

Filter by status. Default returns all.

emailstring

Filter by exact email match.

externalIdstring

Filter by externalId.

createdAfterstring date-time

Filter customers created after this timestamp.

createdBeforestring date-time

Filter customers created before this timestamp.

limitinteger

cursorstring

Response

List of customers

hasMoreboolean required

cursorstring

Opaque pagination cursor - pass back as the cursor query param to fetch the next page. Absent on the last page.

Example response

{
  "data": [
    {
      "id": "cst_01H9Xa8F5dN6mP3q",
      "object": "customer",
      "type": "individual",
      "firstName": "Jane",
      "lastName": "Smith",
      "email": "jane@example.com",
      "phone": "+12125551234",
      "nationality": "US",
      "externalId": "usr_12345",
      "status": "active",
      "signedAgreement": true,
      "signedAgreementAt": "2026-03-20T14:15:22Z",
      "wallets": [
        {
          "id": "wlt_01H9Xb3K7nM2pQ4r",
          "type": "custodial",
          "address": "0x7B3a9F2c4D1eA8bF6390cE5d2B7fA104C8e3D9b1",
          "network": "polygon",
          "asset": "usdc",
          "balance": "1234.56",
          "estimatedValueUsd": "1234.56"
        }
      ]
    }
  ]
}