Skip to main content
Programmatic access to the same numbers your Cabinet’s Referrals tab shows. Auth required (cookie, bearer, or x-api-key).

​
Endpoints

MethodPathReturns
GET/referrals/statsdirect, total, by_level[], earned_micro
GET/referrals/tree?depth=2&limit=50Nested invite tree, paged
GET/referrals/earnings?limit=100Ledger entries with kind = 'referral_reward'
GET/ledger?limit=100Full FLOW ledger for the user

​
SDK

const stats = await af.referrals.stats();
console.log(`${stats.direct} direct, ${stats.total} total invites`);

const earnings = await af.referrals.earnings({ limit: 50 });
const totalEarned = earnings.items.reduce((s, e) => s + Number(e.amount), 0);

// Full ledger
const ledger = await af.ledger.list({ limit: 100 });

​
Pagination

tree and earnings use opaque cursor pagination — pass back next_cursor from the previous response.

​
Webhooks

Subscribe to the referral.reward slice via the payment.received event family — see Webhooks.