Get users invited by current user

Return all users who joined via the current user’s invite code.

GET /api/v1/user/invited

Get users invited by current user

cURL

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

import requests

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

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/invited', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "invited": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "firstName": "<string>",
      "lastName": "<string>",
      "avatarUrl": "<string>",
      "isBusiness": true
    }
  ],
  "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

Response

200

application/json

Successful Response

List of invited users.

invited · InvitedUserResponse · object[] · required

Show child attributes

total · integer · required