Skip to main content
GET
/
referrals
/
businesses
List business referrals
curl --request GET \
  --url https://{defaultHost}/referrals/businesses \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "object": "business_referral",
      "id": "<string>",
      "account": {
        "id": "<string>",
        "title": "<string>",
        "logo_url": "<string>",
        "route": "<string>"
      },
      "payout_percentage": 123,
      "referred_by_account_id": "<string>",
      "referral_started_at": "2023-11-07T05:31:56Z",
      "referral_expires_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "currency": "<string>",
      "processing_volume": 123,
      "total_earnings": 123,
      "pending_payout": 123,
      "completed_payout": 123
    }
  ],
  "page_info": {
    "has_next_page": true,
    "end_cursor": "<string>",
    "has_previous_page": true,
    "start_cursor": "<string>"
  }
}

Authorizations

Authorization
string
header
required

An account API key, account scoped JWT, app API key, or user OAuth token.

Headers

Api-Version-Date
string<date>

Pins the request to a dated API version. When omitted, the request uses the original (2025-01-01) request/response shapes, so existing unversioned callers are never broken. Generated SDKs always send the latest version they were built against. An unrecognized value is rejected with a 400. The schemas documented here always describe the latest version.

Example:

"2026-06-09"

Query Parameters

status
enum<string>

Filter by referral status.

Available options:
active,
removed
has_earnings
boolean

When true, only businesses that have paid out at least one earning to the caller.

first
integer
default:20

Number of business referrals to return from the start of the window.

Required range: x <= 100
after
string

Cursor to fetch the page after (from page_info.end_cursor).

last
integer

Number of business referrals to return from the end of the window.

Required range: x <= 100
before
string

Cursor to fetch the page before (from page_info.start_cursor).

Response

filtered to businesses with earnings

data
object[]
required
page_info
object
required