list_referrals

This is your own referral record and cannot be pointed at anybody else, and it needs no workspace. A referral is listed once its workspace starts a paid subscription carrying your code, so a free signup is not in it, and Share and Earn invites, a separate program, are not counted here.

Each referral has a masked first name in Name, its Plan, BillingPeriod, Status (active, canceled or overdue), JoinedAt and MonthlyEarnings, your commission in dollars. Search by name with term, narrow by status and page with offset and limit, and the answer states the total. See Referrals and payouts.

Inputs

Input	Type	Required	Description
term	string	No	Matches part of the referred person's name.
status	string	No	Only referrals in this status: active, canceled or overdue.
sort	string	No	oldest puts the oldest first. Anything else, or leaving it out, puts the newest first, by the date the referred workspace was created.
offset	integer	No	How many to skip.
limit	integer	No	How many to return. Defaults to 8 and is capped at 120.