List saved contacts

List saved contacts using opaque cursor pagination.

GET /contacts

List saved contacts

cURL

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

200

{
  "items": [
    {
      "id": "ct_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
      "name": "<string>",
      "isExternal": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "icon": "<string>",
      "lastUsedAt": "2023-11-07T05:31:56Z",
      "email": "<string>",
      "address": {
        "streetAddress": "<string>",
        "addressLine2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "AF",
        "zip": "<string>"
      },
      "bank": {
        "method": "<string>",
        "currency": "<string>",
        "fields": {
          "iban": "<string>",
          "bic": "<string>",
          "accountNumber": "<string>",
          "routingNumber": "<string>",
          "pixKey": "<string>",
          "pixKeyType": "phone",
          "paymentKey": "<string>",
          "financialInstitutionId": "<string>",
          "branchNumber": "<string>",
          "accountKind": "checking",
          "phoneNumber": "<string>"
        },
        "holder": {
          "type": "individual",
          "firstName": "<string>",
          "lastName": "<string>",
          "businessName": "<string>",
          "address": {
            "streetAddress": "<string>",
            "addressLine2": "<string>",
            "city": "<string>",
            "state": "<string>",
            "country": "AF",
            "zip": "<string>"
          },
          "idType": "passport",
          "idNumber": "<string>",
          "taxId": "<string>",
          "nationality": "<string>"
        },
        "state": "active",
        "bankName": "<string>",
        "bankAddress": {
          "addressLine1": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postalCode": "<string>",
          "country": "<string>"
        },
        "intermediaryBank": {
          "bic": "<string>",
          "name": "<string>",
          "address": {
            "addressLine1": "<string>",
            "city": "<string>",
            "state": "<string>",
            "postalCode": "<string>",
            "country": "<string>"
          },
          "accountNumber": "<string>"
        },
        "paymentReference": "<string>",
        "destinationAccount": "USDC",
        "minimumDeposit": "500.00"
      },
      "crypto": {
        "address": "<string>",
        "chain": "<string>",
        "token": "<string>"
      },
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user": {
        "avatar": "<string>",
        "name": "<string>"
      }
    }
  ],
  "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

limit · integer · default: 50

Required range: 1 <= x <= 100

cursor · string | null

Maximum string length: 512

Response

200

application/json

Successful Response

items · ContactResponse · 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.