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>"
      },
      "user": {
        "id": "<string>",
        "username": "<string>",
        "name": "<string>",
        "profile_picture": {
          "url": "<string>"
        }
      },
      "status": "active",
      "payout_percentage": 123,
      "referral_started_at": "2023-11-07T05:31:56Z",
      "referral_expires_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "volume_usd": {
        "attributed": "<string>",
        "awaiting_settlement": "<string>",
        "settled": "<string>"
      },
      "earnings_usd": {
        "total": "<string>",
        "pending": "<string>",
        "completed": "<string>"
      }
    }
  ],
  "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.

Example:

"2026-07-01"

Query Parameters

​
status
enum<string>

Filter by referral status.

Available options:
active,
removed
​
has_earnings
boolean

When true, only businesses with pending or completed earnings paid 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).

​
order
enum<string>
default:created_at

The field to sort business referrals by.

Available options:
created_at,
referral_started_at,
referral_expires_at,
payout_percentage,
volume_usd,
earnings_usd
​
direction
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
​
active_before
string

Only return business referrals with a transaction before this timestamp.

​
active_after
string

Only return business referrals with a transaction after this timestamp.

Response

business referrals listed

​
data
object[]
required
​
page_info
object
required