Referrals

Referrals reward users for bringing in new organizations. Click and track endpoints are public; management endpoints require authentication.

Resource overview

GET/api/referralsAPI key · Session

POST/api/referralsAPI key · Session

POST/api/referrals/clickPublic

POST/api/referrals/trackPublic

POST/api/referrals/validatePublic

List my referrals

GET/api/referralsAPI key · Session

200

{
  "data": [
    {
      "id": "ref-uuid",
      "code": "JANE-AT-ACME",
      "clicks": 42,
      "signups": 5,
      "conversions": 2,
      "rewardEarned": "50.00",
      "currency": "USD"
    }
  ]
}

Create referral code

POST/api/referralsAPI key · Session

Name	Type	Required	Description
`code`	`string`	Optional	Custom code. Auto-generated when omitted.

Track a click

POST/api/referrals/clickPublic

Called by the landing page to increment the click counter.

Name	Type	Required	Description
`code`	`string`	Required	Referral code.

POST/api/referrals/trackPublic

Called when a referred user completes signup. Idempotent on (code, email).

Name	Type	Required	Description
`code`	`string`	Required	Referral code from the landing URL.
`email`	`string`	Required	Signed-up email.

Validate