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.
Discover who earns under a programme: to find an affiliate's id before approving, suspending or
paying them, to count who is waiting for approval, or to report on the roster. The project is
resolved first so an invisible one is a refusal, and status is typed before the service sees it
so an unknown word is a VALIDATION_FAILED, never a silent empty page.
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 affiliates to list.
statusstringoptionalOptional filter: "pending", "approved" or "suspended".
member_idstringoptionalOptional member UUID, to find that member's affiliate row.
limitintegeroptionalMaximum affiliates to return per page (1..100).
1max100pageintegeroptional1-indexed page number.
1What it returns
{ "data": [ { "id": "0b1c2d3e-4f50-4617-8a9b-0c1d2e3f4a5b", "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13", "program_id": "6e2a7a4f-3b8c-4c21-9f6d-2a3b4c5d6e7f", "member_id": "a1b2c3d4-e5f6-4718-8a9b-0c1d2e3f4a5b", "code": "ADA2026", "status": "approved", "days_balance": 0, "joined_at": "2026-10-08T09:05:00+00:00", "approved_at": "2026-10-08T10:00:00+00:00", "created_at": "2026-10-08T09:05:00+00:00", "updated_at": "2026-10-08T10:00:00+00:00" } ], "meta": { "page": 1, "limit": 25, "total": 1, "has_more": false }}A list row carries no balances
What an affiliate is owed per currency is a computed read, so it rides only
on get_referral_affiliate and on every
write. The payout details an affiliate typed are never surfaced by any tool.
How it fails
VALIDATION_FAILEDstatus is not pending, approved or suspended.
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
get_referral_program
Fetch a project's Referral Program — what referrers earn, what friends receive, who may join, the hold, the creator's terms and the plans that count. Read-only.
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.