Get user contacts

Get all contacts for the current user.

GET /api/v1/user/contacts

Get user contacts

cURL

curl --request GET \
  --url https://api.hevn.finance/api/v1/user/contacts \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.hevn.finance/api/v1/user/contacts"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.hevn.finance/api/v1/user/contacts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "contacts": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "<string>",
      "address": {
        "streetAddress": "<string>",
        "addressLine2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zip": "<string>"
      },
      "iban": {
        "bankName": "<string>",
        "ibanNumber": "<string>",
        "beneficiaryName": "<string>",
        "bankAddress": "<string>",
        "currency": "<string>",
        "accountHolderFirstName": "<string>",
        "accountHolderLastName": "<string>",
        "accountHolderBusinessName": "<string>",
        "accountHolderAddress": {
          "streetAddress": "<string>",
          "addressLine2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zip": "<string>"
        },
        "paymentReference": "<string>",
        "accountType": "sepa",
        "bic": "<string>"
      },
      "crypto": {
        "address": "<string>",
        "chain": "<string>",
        "token": "<string>"
      },
      "user": {
        "avatar": "<string>",
        "name": "<string>"
      }
    }
  ],
  "total": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · default: Bearer <token> · required

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

Headers

x-api-key · string | null

Query Parameters

limit · integer · default: 100

Required range: 1 <= x <= 500

offset · integer · default: 0

Required range: x >= 0

Response

200

application/json

Successful Response

List of contacts response.

contacts · ContactResponse · object[] · required

Show child attributes

total · integer · required