Read your Share and Earn invite
get_share_and_earn
Reads your Share and Earn invite code and the three figures the Share and Earn window shows.
Share and Earn is the referral program that pays in credits, behind the Spread the word card in the sidebar. It is separate from the affiliate program that list_referrals and list_payouts read.
Code is your invite code, and your invite link is the Modulify address with /invite/ and that code appended. SignupCredits is what you and each person who signs up through the link get, and RewardCredits is what you get the first time that person pays. TotalReferrals counts the accounts created through your link, RewardedReferrals how many of them have paid, and TotalCreditsEarned adds up the credits you earned, the same three figures the window shows. The people themselves are not listed.
It always reads the token holder and cannot be pointed at anybody else.
Request
Call it with a POST to https://api.modulify.ai/v1/get_share_and_earn. It takes no inputs, so send an empty JSON object or no body at all. The token needs the account:read scope.
It only reads and changes nothing, so retrying it is safe.
curl -X POST https://api.modulify.ai/v1/get_share_and_earn \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{}'Over MCP, the same method is the get_share_and_earn tool.
Inputs
This tool takes no inputs.
Response
Every call answers with the JSON envelope of success, message, data, code and version. data holds the result described above, and on a method that returns a total, count carries it. The response headers carry the call's X-Request-Id and what is left of your per-minute budget in X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset. Errors explains every status code a call can answer with.