---
title: "Your invite link and referral progress"
method: GET
path: "/me/referral"
tags: ["Account"]
---

# Your invite link and referral progress

`GET /me/referral`

## Request

- Base URL: `https://yungle.co/api/v1`
- URL: `https://yungle.co/api/v1/me/referral`
- Auth: HTTP bearer

The invite link and code of the person who owns this key, and how many free months they have earned. A friend who subscribes through it gets their first month free; once they have paid for 14 days, the owner gets a month free too.

## Response `200`

Invite code, link and progress.

- Referral
  - `code` string, required: Your invite code. A friend can type it in Settings › Plan.
  - `url` string, uri, required: Your invite link — the same code, as a page that signs them up.
  - `earnedMonths` integer, required: Free months earned so far.
  - `remainingMonths` integer, required: Free months still available to earn.
  - `cap` integer, required: The most free months one person can earn, ever.
  - `capped` boolean, required: True once `earnedMonths` reached `cap`. The link still gives friends their month.
  - `pending` integer, required: Friends in their free month, or inside the 14 days after their first payment.

## Other responses

- `401`: Missing or invalid credential. Codes: `unauthorized`.
- `402`: Needs a paid plan, or prepaid credit for metered usage. Codes: `upgrade_required`, `out_of_credit`.
- `403`: The credential lacks a required scope, or a shared link refused access. Codes: `insufficient_scope`, `password_required`, `wrong_password`, `guests_only`.
- `404`: No such resource in this workspace. Codes: `not_found`.
- `429`: Rate limit or email budget exhausted. Wait for `Retry-After`. Codes: `rate_limited`, `email_budget_exhausted`.
- `500`: Our fault. `details.requestId` ties it to our logs. Codes: `internal_error`.

---

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