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
- 200
- 401
- 403
The referrer's summary.
Not authenticated. code: account_disabled means the member's seat was deactivated in this workspace: the session is over even though the token was not revoked (clients sign out and clean up).
Authenticated but not allowed.