List clients

Every account connected to you, newest first.

GET /clients

List clients

cURL

curl --request GET \
  --url https://api.example.com/clients \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "id": "cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
      "status": "provisioning",
      "createdAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "baseSmartWallet": "<string>",
      "kybStatus": "notStarted",
      "kybApplicationId": "kyb_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
      "failure": {
        "code": "provisioning_failed",
        "message": "<string>",
        "retriable": false
      },
      "pollUrl": "<string>",
      "transferPolicy": {
        "allowFiat": true,
        "allowCrypto": true,
        "allowThirdParty": true,
        "allowEscrowThirdParty": true,
        "allowSwap": true,
        "allowPartnerGroupPayments": true,
        "dualApproval": true,
        "isFrozen": true,
        "recoveryModeActivated": true
      }
    }
  ],
  "nextCursor": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Hevn-Account · string | null

The client account to act for, as a cl_… id. Omit it to act as yourself.

Example:

"cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"

Query Parameters

email · string<email> | null

Exact match, lowercased.

status · enum<string> | null

Available options: provisioning, ready, failed

limit · integer · default: 50

Required range: 1 <= x <= 100

cursor · string | null

Maximum string length: 512

Response

200

application/json

Successful Response

items · ClientResponse · object[] · required

Resources in this page, in stable server-defined order.

Show child attributes

nextCursor · string | null

Opaque cursor for the next page; absent when this is the final page.