---
title: "Get Referral Dashboard"
method: GET
path: "/api/referral/{user_id}"
tags: ["Referral"]
---

# Get Referral Dashboard

`GET /api/referral/{user_id}`

## Request

- Base URL: `https://api.earmarkiq.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.earmarkiq.app/api/referral/{user_id}`
- Auth: HTTP bearer

Get the user's referral dashboard: code, stats, and referral list.

## Path parameters

- `user_id` string, uuid, required

## Response `200`

Successful Response

- ReferralDashboard
  - `referral_code` string, nullable, required
  - `total_invited` integer, required
  - `total_signed_up` integer, required
  - `total_rewarded` integer, required
  - `premium_months_earned` integer, required
  - `has_permanent_premium` boolean, required
  - `referrals` ReferralItem[], required
    - `id` string, required
    - `referred_email` string, nullable, required
    - `referred_name` string, nullable
    - `status` string, required
    - `reward_months_earned` integer, required
    - `created_at` string, required
    - `redeemed_at` string, nullable
    - `rewarded_at` string, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/earmarkiq/apis/earmark-api.md) · [All operations](https://skmtc.dev/earmarkiq/apis/earmark-api/llms.txt) · [OpenAPI document](https://skmtc.dev/earmarkiq/apis/earmark-api/revisions/4a2c41907105?raw)