Sign in
Partner Referral Requests

List partner referral requests

Lists your referral links and attribution requests, including incoming requests for you or businesses you own, with filters for recipient, partner, type, and status.

get/partner_referral_requests

Query parameters

account_idstring

Only requests for this business ID, prefixed biz_.

target_user_idstring

Only requests received by this user ID, prefixed user_.

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

Changes

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

  • 86b97292852d2See the full diff
    • ○

      added the new optional query request parameter target_user_id

      new-optional-request-parameter

    • ○

      added the required property // to the response with the status

      response-required-property-added

  • 140d015b9966112See the full diff
    • ▲

      removed the enum value reward_link from the query request parameter request_type

      request-parameter-enum-value-removed

    • ●

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

      response-property-enum-value-added

    • ○

      added the new enum value link to the query request parameter request_type

      request-parameter-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.