Sign in
Partner Referral Requests

List partner referral requests

Lists requests sent by an eligible partner and requests for accounts where the authenticated user currently holds the owner role. Filters narrow that combined view. 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 return their owner's sent requests and incoming requests for the key's account.

get/partner_referral_requests

Query parameters

account_idstring

Only requests for this business ID, prefixed biz_.

partner_idstring

Only requests sent by this partner's user ID, prefixed user_.

status'pending' | 'accepted' | 'denied' | 'cancelled'

Only requests with this approval status.

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

Only requests initiated in this way.

order'created_at'

Field used to sort requests.

direction'asc' | 'desc'

Sort direction.

firstinteger

Number of results to return from the start of the range.

afterstring

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

lastinteger

Number of results to return from the end of the range.

beforestring

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

Response

Requests listed.

Example response

{
  "data": [
    {
      "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",
      "rewards": [
        {
          "bot_qualification_type": "sales",
          "qualification_amount": {
            "amount": "-2.50",
            "currency": "usd",
            "decimals": 2,
            "display_decimals": 2
          },
          "recipient": "business",
          "reward_amount": {
            "amount": "-2.50",
            "currency": "usd",
            "decimals": 2,
            "display_decimals": 2
          }
        }
      ],
      "status": "accepted",
      "updated_at": "2026-01-01T12:00:00.000Z"
    }
  ],
  "page_info": {
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

Changes