Skip to main content
GET
TypeScript

Autorizaciones

Authorization
string
header
requerido

A user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

partner:basic:read
referral:basic:read
company:basic:read

Encabezados

Api-Version-Date
string

Pins the request to a dated API version.

Ejemplo:

"2026-11-17"

Parámetros de consulta

referring_account_id
string

List the referrals this business's team members made, past members included, instead of the authenticated user's own. Requires company:basic:read on that business, which every team member holds, and cannot be combined with user_id. The owner role reads every referral; anyone else reads only the referrals made by themselves and by the people under them in the org chart.

advance_status
enum<string>

Filter the authenticated partner's CPA offers by status, or with referring_account_id, the CPA terms of the reps the caller manages. Use offered for every state after qualification.

Opciones disponibles:
projected,
available,
accepted,
funded,
clawed_back,
completed,
expired,
withdrawn,
offered
status
enum<string>

Filter by referral status.

Opciones disponibles:
active,
removed
has_earnings
boolean

When true, only businesses with pending or completed earnings paid to the caller.

first
integer
predeterminado:20

Number of results to return from the start of the range.

Rango requerido: x <= 100
after
string

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

last
integer

Number of results to return from the end of the range.

Rango requerido: x <= 100
before
string

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

include_total_count
boolean

Set to true to return the number of matching results in page_info.total_count. Send first=0 as well to return the count without any results.

order
enum<string>
predeterminado:created_at

The field to sort partner businesses by.

Opciones disponibles:
created_at,
referral_started_at,
referral_expires_at,
payout_percentage,
volume_usd,
volume_30d_usd,
earnings_usd
direction
enum<string>
predeterminado:desc

Sort direction.

Opciones disponibles:
asc,
desc
created_before
string

Only return partner businesses created before this timestamp.

created_after
string

Only return partner businesses created after this timestamp.

first_sale_before
string

Only return partner businesses whose first paid sale above zero happened before this timestamp.

first_sale_after
string

Only return partner businesses whose first paid sale above zero happened after this timestamp. Combined with first_sale_before, this is the net new set: businesses that processed their first $1 inside the window.

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 referrals from a single tier: first, second, or blueprint.

Opciones disponibles:
first,
second,
blueprint
business_prefix_query
string

Case-insensitive business-name prefix, or an exact biz_ account ID. Surrounding whitespace is ignored; blank values apply no filter.

earning_partner_id
string

Only the referrals this team member made, plus the ones they were added to as a deal participant. User ID, prefixed user_. Requires referring_account_id.

Respuesta

partner businesses listed

data
object[]
requerido
page_info
object
requerido