---
title: "Get Referral Info"
method: GET
path: "/api/app-auto-gtm/referral"
tags: ["AppAutoGtm"]
---

# Get Referral Info

`GET /api/app-auto-gtm/referral`

The referral page payload (T-17): the org's share link (code minted
lazily on first visit) + the "who I invited" ledger from ``guest_referral``.

``started`` rows (link visited, no card yet) surface as ``pending`` with a
NULL email — the visitor is anonymous until they pay.

## Cookies

- `ex_access` string, nullable
- `ex_org` string, nullable

## Response `200`

Successful Response

- ReferralInfoResponse — Everything the referral page renders: the org's share link + the ledger. ``banned=True`` (T-980 fraud clawback) → ``code``/``link`` are empty and the page shows a "program not available" state instead of the share card.
  - `code` string
  - `link` string
  - `reward_usd` integer, required
  - `cap_usd` integer, required
  - `earned_usd` integer, required
  - `banned` boolean
  - `rows` ReferralRow[]
    - `email` string, nullable
    - `invited_at` string, date-time, required
    - `status` 'pending' | 'card_verified' | 'granted' | 'rejected', required
    - `reward_usd` integer

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/explee/apis/explee-api.md) · [All operations](https://skmtc.dev/explee/apis/explee-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/explee/explee-api/revisions/f169bc6e9447/schema)