Referral programme
referrals_overviewThe workspace's referral and affiliate standing: the referral code and the link to share, how many people have opened it, how many signed up, how many went on to pay, the commission rate and what the next rate needs, and the earnings split into money still on hold, money available to withdraw, money already paid out and account credit. Also lists the recent sign-ups with the date and the plan they took, and no personal details, because the route sends none. Use it for 'what is my referral link', 'how many people have joined through me', 'how much have I earned' or 'when can I withdraw'. Amounts are in ordinary units of the currency shown, not paise or cents. It covers the whole workspace, so it takes no account id.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | How many recent sign-ups to return, newest first. Defaults to 20; 50 is the most this tool will ever return. |