Skip to main content

Get the referrer's share code + stats

GET 

/api/referral

Returns the current tenant's referral share code + link and headline stats: how many tenants it referred, how many became paying (active), lifetime earnings, the in-hold pending amount, and the claimable available balance (all minor units), plus the programme currency and minimum payout. Admin / account owner only. RLS-scoped to the referrer — only its own aggregates, never a referred tenant's identity.

Responses​

The referrer's summary.