---
title: "Api Referral Code"
method: GET
path: "/api/referral/code"
---

# Api Referral Code

`GET /api/referral/code`

## Request

- Base URL: `https://www.oxfordledge.com` (the document declares no server; this is the origin it was published from)
- URL: `https://www.oxfordledge.com/api/referral/code`
- Auth: none declared

Get or generate referral code.

## Response `200`

Successful Response

- ReferralCodeResponse: `/api/referral/code` — fetch or generate the user's referral code. F4 boundary backfill 2026-05-08 (Initiative 6). Auth-required. FE settings panel reads `code`, `uses`, and `referrals[].redeemed_at` to render the referral panel. Empty `referrals` list when row exists but no redemptions yet; absent on freshly-generated rows.
  - `status` string, required: 'ok' on success. Error path returns api_error envelope (top-level 'error') instead.
  - `code` string, required: The user's referral code, format 'OL-<6 alphanum>'.
  - `uses` integer, required: Number of redemptions of this code so far.

---

[API](https://skmtc.dev/oxfordledge/apis/oxford-ledge-api.md) · [All operations](https://skmtc.dev/oxfordledge/apis/oxford-ledge-api/llms.txt) · [OpenAPI document](https://skmtc.dev/oxfordledge/apis/oxford-ledge-api/revisions/e832a1260f0b?raw)