Skip to main content
GET
List a partner's referred businesses

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-07-08-1"

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 partner businesses 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 partner businesses 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 partner businesses 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
created_before
string

Only return partner businesses created before this timestamp.

created_after
string

Only return partner businesses created after this timestamp.

referred_user_id
string

Filter to referrals attributed to this user. For first-tier referrals, this is the referred account owner; for second-tier referrals, this is the partner you recruited.

referred_username
string

Filter by the referred user's exact username. Ignored when referred_user_id is present.

tier
enum<string>

Filter to only first-tier referrals or only second-tier referrals.

Available options:
first,
second

Response

partner businesses listed

data
object[]
required
page_info
object
required