API Reference
9 Referrals API endpoints for web scraping workflows, with REST paths, authentication requirements, parameters, examples, and MCP tool metadata where supported.
/admin/referralsadmin or apiKey1 credit/requestLists referral attributions with their reward records for support and operational review.
Params: x-api-key:header, user_id:query, status:query, campaign:query, pending_grant:query, limit:query
/admin/referrals/{id}admin or apiKey1 credit/requestReturns one referral attribution and its reward records.
Params: x-api-key:header, id:path
/admin/referrals/{id}/approveadmin or apiKey1 credit/requestApproves a review-required referral and resumes idempotent reward granting.
Params: x-api-key:header, id:path
/admin/referrals/{id}/rejectadmin or apiKey1 credit/requestRejects a review-required referral without granting credits.
Params: x-api-key:header, id:path, request:body
/admin/referrals/recoveradmin or apiKey1 credit/requestRetries referral rewards whose credits were not marked as granted. Billing grants are keyed so retries do not double-credit users.
Params: x-api-key:header, limit:query
/admin/referrals/statsadmin or apiKey1 credit/requestReturns referral clicks, attributed signups, qualification, reward, cap, and review counts.
Params: x-api-key:header, from:query, to:query, campaign:query
/referrals/clickpublic1 credit/requestRecords sanitized referral click metadata for attribution analytics.
Params: request:body
/referrals/mejwt1 credit/requestReturns the authenticated user's referral code, share path, reward settings, aggregate stats, and recent referral records.
Params: Authorization:header
/referrals/me/eventsjwt1 credit/requestReturns recent referral attribution records where the authenticated user is either the referrer or referred account.
Params: Authorization:header, limit:query