List your referral payouts

list_payouts

Lists the payouts made to you for referrals, with their status.

POST /v1/list_payoutsScopeaccount:readRead only

This is your own payout record and cannot be pointed at anybody else, and it needs no workspace. Pair it with list_referrals when somebody asks what they have earned and what has actually been paid.

Each payout has its TotalEarnings in dollars, TotalUsers, the number of referrals counted into it, its Status (in-review, processing, paid or canceled) and when it was raised. It records what your active referrals were worth on that day, and the answer states the total for paging. See Referrals and payouts.

Request

Call it with a POST to https://api.modulify.ai/v1/list_payouts, sending the inputs below as a JSON object. 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/list_payouts \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP, the same method is the list_payouts tool.

Inputs

Input	Type	Required	Description
`status`	string	No	Only payouts in this status: `in-review`, `processing`, `paid` or `canceled`.
`sort`	string	No	`oldest` puts the oldest first. Anything else, or leaving it out, puts the newest first.
`offset`	integer	No	How many to skip.
`limit`	integer	No	How many to return. Defaults to 8 and is capped at 120.

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.