---
title: "Get Referral Me"
method: GET
path: "/api/v1/referral/me"
tags: ["Referral"]
---

# Get Referral Me

`GET /api/v1/referral/me`

## Request

- Base URL: `https://api.gemstoneaiapp.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.gemstoneaiapp.com/api/v1/referral/me`
- Auth: HTTP bearer

The caller's referral code (lazily generated), share URL, and stats.

## Response `200`

Successful Response

- ReferralMeResponse
  - `referral_code` string, required
  - `share_url` string, required
  - `referred_count` integer, required
  - `scans_earned` integer, required

---

[API](https://skmtc.dev/gemstoneaiapp/apis/gemstoneai-api.md) · [All operations](https://skmtc.dev/gemstoneaiapp/apis/gemstoneai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gemstoneaiapp/apis/gemstoneai-api/revisions/fcb441f55161?raw)