Retrieve a Partner Referral Request
Retrieves a referral link or attribution request by ID, including its partner, recipient, approval status, and referral code when present.
Authorizations
An Account API key or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.
Headers
Pins the request to a dated API version.
"2026-10-07-2"
Path Parameters
Partner referral request ID, prefixed prfr_.
Response
Request retrieved.
Business receiving the request, when one is assigned.
The partner's team membership this referral was created for, prefixed ausr_. null when the referral is personal.
null
Unique referral code, when assigned.
null
When the request was created, as an ISO 8601 timestamp.
"2026-01-01T12:00:00.000Z"
Partner referral request ID, prefixed prfr_.
"prfr_xxxxxxxxxxxxxx"
Maximum permitted redemptions, when limited.
null
Public profile of the requesting partner.
How the referral request was initiated.
manual, ownership_transfer, link "manual"
The approval state, or null for requests without an approval process.
pending, accepted, denied, cancelled, null "accepted"
When the request last changed, as an ISO 8601 timestamp.
"2026-01-01T12:00:00.000Z"
User receiving the attribution request, or null for a business request or referral link.

