---
title: "Your own referral link and signups"
method: GET
path: "/v1/referrals/me"
tags: ["Organization"]
---

# Your own referral link and signups

`GET /v1/referrals/me`

## Request

- Base URL: `https://api.1claw.co`
- URL: `https://api.1claw.co/v1/referrals/me`
- Auth: HTTP bearer

The caller's referral code, the link to share, how many signups it has
produced, and a recent list.

Users only — a referral link belongs to a person, so an agent principal
gets 403.

The link's host comes from the brand the request arrived on, the same
way the SIWE domain and the WebAuthn rpId do: someone on 1claw.co must
not be handed a 1claw.xyz link to post.

`recent[].referred_hint` is masked (`a**@example.com`) — enough to
recognise someone you did invite, not enough to contact someone you did
not. Neither the referred address nor its user id is returned.

## Query parameters

- `from` string, date-time
- `to` string, date-time

## Response `200`

The caller's referral code, link and signup count

- MyReferralsResponse
  - `code` string, required: The caller's referral code, created on first read.
  - `link` string, uri, required: The URL to share, built for the brand the request arrived on.
  - `total` integer, required: Countable signups attributed to this code, one per person.
  - `qualified` integer, required: Of those, the ones on a live paid subscription — what a contest settles on. Always <= `total`.
  - `from` string, date-time: Echoed back when a window was requested, so a caller can confirm which window produced these numbers.
  - `to` string, date-time
  - `recent` ReferralRow[], required
    - `signup_method` string, required: How the referred person signed up.
    - `created_at` string, date-time, required
    - `referred_hint` string, nullable: Masked address — first character, then the domain.

## Other responses

- `403`: The caller is an agent, not a person.

---

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