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.
Read the one programme a project holds, in the flat keys update_referral_program
takes, so an agent can read a setting back and write it unchanged. The project is resolved first,
with the tenant scope and the token's scope:project: allow-list applied, so an invisible project
is a refusal rather than an empty answer; a project with no programme is the same
RESOURCE_NOT_FOUND.
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 Referral Program to fetch.
What it returns
{ "data": { "id": "6e2a7a4f-3b8c-4c21-9f6d-2a3b4c5d6e7f", "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13", "active": true, "customers_only": false, "approval_required": false, "reward_kind": "cash", "reward_days": null, "commission_type": "percentage", "commission_value": "20.0000", "commission_currency_id": null, "commission_currency": null, "commission_period_months": 6, "hold_days": 14, "minimum_payout": "50.0000", "friend_reward_kind": "free_days", "friend_reward_days": 3, "friend_coupon_id": null, "payout_details_label": "PayPal email", "terms": "One referral per household.", "plan_ids": [], "created_at": "2026-10-01T09:14:02+00:00", "updated_at": "2026-10-08T16:41:11+00:00" }}`plan_ids: []` means every plan, not no plans
An empty array means a conversion on any plan in the project counts, including plans added later. Do not summarise it as "no plans".
commission_period_months is 0 for the friend's first payment only, a number of months, or
null for life; a fixed commission is always the first payment only. commission_value is a
decimal string with four places, parsed as a decimal, never a float. minimum_payout is a guide
for the creator and enforces nothing.
How it fails
RESOURCE_NOT_FOUNDunknown project_id, a project on another team, one outside the token's
AUTHENTICATION_REQUIREDno authenticated user on the request.
TOKEN_MISSING_ABILITYtoken lacks project-referral:view.
How is this guide?
Last updated on
get_referral_affiliate
Fetch one affiliate with their code, status, days balance and what they are owed per currency. Read-only; never their payout details.
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.