Organization

Your own referral link and signups

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.

get/v1/referrals/me

Request

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

Query parameters

fromstring date-time

Start of a half-open window [from, to) on when the referral was made. Same boundary rule as the admin leaderboard, so the two cannot disagree about a referral landing on the edge. Omit for no lower bound.

tostring date-time

End of the window, exclusive. A contest run "through the 31st" passes the 1st of the next month. Omit for no upper bound.

Response

The caller's referral code, link and signup count

codestring required

The caller's referral code, created on first read.

linkstring uri required

The URL to share, built for the brand the request arrived on.

totalinteger required

Countable signups attributed to this code, one per person.

qualifiedinteger required

Of those, the ones on a live paid subscription — what a contest settles on. Always <= total.

fromstring date-time

Echoed back when a window was requested, so a caller can confirm which window produced these numbers.

tostring date-time

Example response

{
  "code": "7f3a9c2b",
  "link": "https://1claw.co/?ref=7f3a9c2b",
  "recent": [
    {
      "signup_method": "email_otp",
      "referred_hint": "a**@example.com"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.