Skip to main content
GET
TypeScript

Autorisationer

Authorization
string
header
påkrævet

An Account API key or 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

Overskrifter

Api-Version-Date
string

Pins the request to a dated API version.

Eksempel:

"2026-11-17"

Sti-parametre

id
string
påkrævet

The partner business ID (a coma_ identifier).

Forespørgselsparametre

status
enum<string>

Filter by earning status.

Tilgængelige muligheder:
awaiting_settlement,
pending,
completed,
canceled,
reversed
income_source
enum<string>[]

Filter to earnings from these income sources. Repeat the parameter for each one (income_source=sales&income_source=ad_spend).

Tilgængelige muligheder:
sales,
ad_spend,
transfer,
card_interchange,
withdrawal,
business_referral,
onboarding_reward,
partner_reward,
verified_partner_referral_payback,
commission_advance
first
integer
standard:20

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

Nødvendigt interval: 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.

Nødvendigt interval: x <= 100
before
string

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

order
enum<string>
standard:created_at

The field to sort earnings by.

Tilgængelige muligheder:
created_at,
commission_amount,
transaction_amount,
payout_at
direction
enum<string>
standard:desc

Sort direction.

Tilgængelige muligheder:
asc,
desc
created_before
string

Only return earnings created before this timestamp.

created_after
string

Only return earnings created after this timestamp.

Svar

earnings listed

data
object[]
påkrævet
page_info
object
påkrævet