TEASEDocs
ProductsClubHow-to

Get and share your referral link

Fetch your own referral code and share link, see your conversion stats, and list who you referred.

Who this is for: any signed-in TEASE account holder — this is the platform's own account-to-account referral program, separate from the workspace-owner admin panel described everywhere else in this area.

A different auth model than the rest of this area

Every other endpoint in this area authenticates with an al_live_* Bearer key. These three are mounted under /api/me and authenticate with the signed-in browser session cookie instead — they're read from inside your own TEASE account, not called from an external integration.

Get your code and stats

curl https://app.tease.link/api/me/referral \
  -H "Cookie: user_session=..."
{ "code": "kX7mQ2pL", "link": "<app_public_url>/?ref=kX7mQ2pL",
  "invited_count": 12, "converted_count": 9, "reward_count": 9 }

link is built from the deployment's own public site URL plus ?ref=<code> — it always points at wherever this TEASE instance's own sign-up page actually lives, not a fixed domain.

The code is minted on first call and stable after that — calling this again always returns the same code and link, never a new one. invited_count is everyone who ever redeemed the code; converted_count and reward_count currently move together (every successful redemption grants the reward immediately, with no separate approval step).

List every referral

curl https://app.tease.link/api/me/referral/list \
  -H "Cookie: user_session=..."
{ "items": [ { "id": 88, "code": "kX7mQ2pL#4021", "invited_user_id": 4021,
               "status": "converted", "reward_granted": true, "created_at": 1751877000 } ] }

Newest first. Each row is one converted invitee — the code shown here is the referrer's code with the invitee's id appended, an internal bookkeeping detail, not a second code to share.

How redemption works (for context)

The invitee side — POST /api/me/referral/claim { "code": "..." } — is called by the freshly-registered account itself right after signup, using the ?ref= code it captured at signup. It's idempotent (redeeming twice just answers already_claimed, no second reward) and refuses self-referral outright. It answers {"ok": true/false, "status": "..."} rather than an error for every non-conversion case — disabled (the program is off account-wide), unknown_code, self_referral, and already_claimed are all clean no-ops, not failures a caller needs to handle specially.

What's next

This program lives entirely under /api/me — for everything else in this area, return to Campaigns & promotions concepts.

On this page