Sign in
Partner Referral Requests

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.

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' | '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",
  "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",
  "user": {
    "id": "user_xxxxxxxxxxxxxx",
    "name": "Dana Whitfield",
    "profile_picture": {
      "url": "https://ui-avatars.com/api/"
    },
    "username": "danawhitfield"
  }
}

Changes

Changed in 4 of the 74 revisions of this API.14

  • 86b97292852d1See the full diff
    • ○

      added the required property to the response with the status

      response-required-property-added

  • 140d015b996611See the full diff
    • ●

      added the new link enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      removed the reward_link enum value from the response property for the response status

      response-property-enum-value-removed

  • d629b0d5d8391See the full diff
    • ○

      added the required property to the response with the status

      response-required-property-added

  • 355991ab86d51See the full diff
    • ○

      endpoint added

      endpoint-added

Of the 74 revisions, 1 has no diff computed.