get_referral
Fetch one referral — the affiliate, the friend's member id, how they arrived, whether they paid and until when the affiliate earns on them. Read-only.
Read one referral in full. The row is the same one
list_referrals emits, so an agent that spotted a referral
in the list, or read its id off a referral.captured or referral.converted event, reads exactly
the same fields back here.
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 the referral belongs to.
referral_id*stringUUID of the referral to fetch.
What it returns
{ "data": { "id": "3c4d5e6f-7081-4a2b-9c3d-4e5f6a7b8c9d", "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13", "program_id": "6e2a7a4f-3b8c-4c21-9f6d-2a3b4c5d6e7f", "affiliate_id": "0b1c2d3e-4f50-4617-8a9b-0c1d2e3f4a5b", "member_id": "b2c3d4e5-f6a7-4819-9b0c-1d2e3f4a5b6c", "source": "portal_link", "connector": null, "status": "touched", "touched_at": "2026-10-08T11:00:00+00:00", "expires_at": "2026-11-07T11:00:00+00:00", "converted_at": null, "converted_subscription_id": null, "commission_ends_at": null, "created_at": "2026-10-08T11:00:00+00:00" }}A touched referral has no conversion yet: converted_at, converted_subscription_id and
commission_ends_at are null until the friend's first payment settles.
How it fails
RESOURCE_NOT_FOUNDunknown project_id or referral_id, a referral of another project, or a
AUTHENTICATION_REQUIREDno authenticated user on the request.
TOKEN_MISSING_ABILITYtoken lacks project-referral:view.
How is this guide?
Last updated on