Retrieve a Partner Referral Request
Retrieves a request visible to its eligible sender or a current owner of the receiving account. Use a Whop login session or an account API key with partner:referral_request:read. The key must have been created by the account’s current owner. Account API keys can retrieve their owner’s sent requests and incoming requests for the key’s account.
Authorizations
An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.
Headers
Pins the request to a dated API version.
"2026-09-15"
Path Parameters
Partner referral request ID, prefixed prfr_.
Response
Request retrieved.
Business receiving the request, when one is assigned.
Unique referral code, when assigned.
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.
Public profile of the requesting partner.
How the referral request was initiated.
manual, ownership_transfer, reward_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"

