Skip to main content
GET
Get the caller's referral program page data

Authorizations

Authorization
string
header
required

JWT authentication token

Response

Referral program data

amounts
object
required

Server-computed credit + USD amounts. USD = credits x credit rate, computed server-side; the UI never does the math or hardcodes numbers.

Shareable sign-up link with the code embedded (ref=CODE); the code is never surfaced separately

max_rewards
integer
required

Lifetime successful-referral cap (config-sourced), shown as X of N

program
enum<string>
required
Available options:
payg,
enterprise
referrals
object[]
required
stats
object
required
leads
object[]

Enterprise program only: the caller's submitted sales leads (omitted/empty for PAYG)