Sign in
Partner Referral Requests

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.

get/partner_referral_requests/{id}

Response

Request retrieved.

codestring nullable required

Unique referral code, when assigned.

created_atstring required

When the request was created, as an ISO 8601 timestamp.

idstring required

Partner referral request ID, prefixed prfr_.

max_redemptionsinteger nullable required

Maximum permitted redemptions, when limited.

request_type'manual' | 'ownership_transfer' | 'reward_link' required

How the referral request was initiated.

status'pending' | 'accepted' | 'denied' | 'cancelled' | 'null' nullable required

The approval state, or null for requests without an approval process.

updated_atstring required

When the request last changed, as an ISO 8601 timestamp.

Example response

{
  "account": {
    "id": "biz_xxxxxxxxxxxxxx",
    "title": "Shine Time Auto Detailing"
  },
  "created_at": "2026-01-01T12:00:00.000Z",
  "id": "prfr_xxxxxxxxxxxxxx",
  "partner": {
    "id": "user_xxxxxxxxxxxxxx",
    "name": "Dana Whitfield",
    "profile_picture": {
      "url": "https://ui-avatars.com/api/"
    },
    "username": "danawhitfield"
  },
  "request_type": "manual",
  "status": "accepted",
  "updated_at": "2026-01-01T12:00:00.000Z"
}

Changes