Skip to main content
GET
/
api
/
v1
/
user
/
rewards
Get referral rewards earned by current user
curl --request GET \
  --url https://api.hevn.finance/api/v1/user/rewards \
  --header 'Authorization: Bearer <token>'
{
  "rewards": [
    {
      "id": "<string>",
      "date": "2023-11-07T05:31:56Z",
      "refereeName": "<string>",
      "refereeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": "<string>",
      "currency": "USD"
    }
  ],
  "totalAmount": "<string>",
  "currency": "USD"
}

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
​
cursor
string | null

Reserved for future pagination

Response

Successful Response

List of referral rewards earned by the current user.

​
rewards
RewardItem · object[]
required
​
totalAmount
string
required
​
currency
string
default:USD