Version
READ

get_partner_referral

Read one of the partner's referrals by UUID — who signed up, its status and what the conversion earned. Read-only.

Fetch one referral of the authenticated partner, the same row list_partner_referrals pages: who signed up through the link, the typed code or the bot's deep link, the referral's status, its conversion window and what the conversion earned. The token says whose partnership; there is no partner id to pass.

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.

The REST endpoint and this tool share one action, so validation, permissions and events are identical.

Annotations

Read-only

It reads and never changes anything.

Arguments

referral_id*string

UUID of the referral to fetch, from `list_partner_referrals`.

How it fails

RESOURCE_NOT_FOUND

the id is unknown, belongs to another partner, or the caller never applied for the Partner Program.

TOKEN_MISSING_ABILITY

token lacks account:read.

Arguments

  • referral_id (required) — UUID of the referral, from list_partner_referrals.

How is this guide?

Last updated on