---
title: "Your referral link and what it has earned"
method: GET
path: "/api/v1/referrals"
tags: ["Referrals"]
---

# Your referral link and what it has earned

`GET /api/v1/referrals`

## Request

- Base URL: `http://localhost:5180`
- URL: `http://localhost:5180/api/v1/referrals`
- Auth: API key in cookie `better-auth.session_token`

A person, not a team: the code is theirs across every team they hold. Made the first time it is read. A referred landlord gets a longer first trial; each one whose team pays earns the referrer a free month on their plan, with a bonus at three and at five. Counts only: nobody referred is named.

## Response `200`

The link and its counts.

- object
  - `ok` unknown, required
  - `data` object, required
    - `enabled` boolean, required: False until the programme launches; then nothing else here is filled in.
    - `code` string, nullable, required
    - `link` string, nullable, required: The sign-up address carrying the code.
    - `signedUp` integer, required: Accounts opened through the link.
    - `paying` integer, required: Of those, the ones whose team has paid an invoice.
    - `monthsEarned` integer, required: Free months earned, tier bonuses included.
    - `monthsApplied` integer, required: Of those, the months already on the Stripe balance of a plan.
    - `nextTier` object, nullable, required
      - `at` number, required
      - `totalMonths` number, required
    - `referredBonusDays` integer, required: The extra trial a referred landlord gets on their first plan.
  - `meta` object, required
    - `requestId` string, required: Echoed in the x-request-id header. Quote it in a bug report.

---

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