---
title: "Referral code, link and earnings (auth required)"
method: GET
path: "/api/v1/referral"
---

# Referral code, link and earnings (auth required)

`GET /api/v1/referral`

## Request

- Base URL: `https://roamzy.io`
- URL: `https://roamzy.io/api/v1/referral`
- Auth: HTTP bearer

Read-only — no money moves through this endpoint. Works for anonymous tokens too: an anonymous agent accrues commission on the cash payments of accounts it refers. Withdrawing to a wallet requires linking a Google/Telegram identity first; spending earnings on the token owner's own traffic does not.

## Response `200`

OK

- object
  - `referral_code` string
  - `referral_link` string, uri
  - `percent` number: Share of each referred account's cash payments
  - `balance_usdt` number
  - `earned_total_usdt` number
  - `invited_count` integer
  - `can_withdraw` boolean
  - `min_withdrawal_usdt` number
  - `hint` string
  - `share_text` string

## Other responses

- `401`: Missing or invalid token

---

[API](https://skmtc.dev/roamzy/apis/roamzy-agent-api.md) · [All operations](https://skmtc.dev/roamzy/apis/roamzy-agent-api/llms.txt) · [OpenAPI document](https://skmtc.dev/roamzy/apis/roamzy-agent-api/revisions/8757b8d0b779?raw)