---
title: "Returns paginated list of referrals for the sender"
method: GET
path: "/v1/referral"
tags: ["Referral"]
---

# Returns paginated list of referrals for the sender

`GET /v1/referral`

## Query parameters

- `order` 'desc'
- `limit` integer
- `cursor` string
- `subaccount` string, hex
- `orderBy` 'createdAt'

## Headers

- `X-Ethereal-Auth` string, required
- `X-Ethereal-Sender` string, hex, required
- `X-Ethereal-Signature` string, hex, required
- `X-Ethereal-Intent` 0 | 1 | 2 | 3, required
- `X-Ethereal-SignedAt` string, required

## Response `200`

- PageOfReferralDtos
  - `data` ReferralDto[], required — Array of referral objects
    - `code` string — The referee's referral code to be shared and claimed by others (undefined if not activated)
    - `codeUsageRemaining` integer, required — Number of remaining times the referral code can be claimed
    - `createdAt` integer, required — Timestamp of when this referral was activated (ms since Unix Epoch)
    - `id` string, uuid, required — Id representing the referral
    - `referee` string, hex, required — Address of the referee (non-checksummed)
    - `refereeTotalPoints` string, decimal, required — Total points (excl. referral points) earned by the referee since referee claimed the code (precision: 9)
    - `referrer` string, hex — Address of the referrer (non-checksummed; undefined if not set)
  - `hasNext` boolean, required — Whether there are more objects to paginate through
  - `nextCursor` string — Pointer to the next page in pagination dataset

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `422` — Unprocessable Entity
- `429` — Too Many Requests
- `500` — Internal Server Error

---

[API](https://skmtc.net/ethereal/apis/ethereal-exchange-api.md) · [All operations](https://skmtc.net/ethereal/apis/ethereal-exchange-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ethereal/ethereal-exchange-api/revisions/6e6f8dad92bf/schema)