list_referral_payouts
List the payouts recorded against a project's affiliates — how much, in which currency, and how many commissions each covered. Read-only, paginated.
Read what the creator has paid out: to reconcile against a bank or PayPal statement, to see when an
affiliate was last paid, or to total a period. Narrow to one affiliate with affiliate_id.
Read-only. Never mutates anything.
Requires ability
The token behind the MCP session must hold it, or the call is refused with TOKEN_MISSING_ABILITY.
Runs the same actions as
The REST endpoint and this tool share one action, so validation, permissions and events are identical.
Annotations
It reads and never changes anything.
Arguments
project_id*stringUUID of the project whose payouts to list.
affiliate_idstringoptionalOptional affiliate UUID, to list one affiliate's payouts.
limitintegeroptionalMaximum payouts to return per page (1..100).
1max100pageintegeroptional1-indexed page number.
1What it returns
{ "data": [ { "id": "c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f", "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13", "affiliate_id": "0b1c2d3e-4f50-4617-8a9b-0c1d2e3f4a5b", "amount": "30.0000", "currency_id": "f0e1d2c3-b4a5-4697-8877-665544332211", "currency": "USD", "reference": "PAYPAL-7F3D1C92", "note": null, "paid_at": "2026-11-01T10:00:00+00:00", "recorded_by_user_id": "d4e5f6a7-b8c9-4d0e-8f1a-2b3c4d5e6f70", "rewards_paid": 3, "created_at": "2026-11-01T10:00:00+00:00" } ], "meta": { "page": 1, "limit": 25, "total": 1, "has_more": false }}rewards_paid is how many payable commissions the payout covered, oldest first.
How it fails
RESOURCE_NOT_FOUNDunknown project_id, a project on another team, or one outside the token's
AUTHENTICATION_REQUIREDno authenticated user on the request.
TOKEN_MISSING_ABILITYtoken lacks project-referral:view-any.
How is this guide?
Last updated on
list_referral_affiliates
List the members enrolled in a project's Referral Program, newest first, by status or member. Read-only, paginated; never their payout details.
list_referral_rewards
List the referral ledger — the days or money each settled payment earned, whose it is and where it stands. Read-only, paginated.