Skip to main content
GET
Get all commissions

Authorizations

Authorization
string
header
required

Access token passed as a Bearer token in the Authorization header

Headers

Account-ID
string
required

Account identifier that specifies which account is making the request

Example:

"acc_123456"

Query Parameters

q
string

Search params. Searches by initial_tier_event.transaction_id, lead.email, lead.uid

filters[status]
enum<string>

Status filter

Available options:
pending,
approved,
denied
filters[paid]
enum<string>

Paid filter

Available options:
yes,
no
filters[sale_amount][from]
integer

Sale amount from

filters[sale_amount][to]
integer

Sale amount to

filters[amount][from]
integer

Amount from

filters[amount][to]
integer

Amount to

filters[created_at][from]
string<date>

Created at start date

filters[created_at][to]
string<date>

Created at end date

filters[campaign_id]

Campaign ids

filters[payout_id]

Payout ids

filters[due_period]
enum<string>

Due period filter

Available options:
next,
overdue,
custom
filters[promoter_id]
integer

Promoter id

filters[first_commission]
enum<string>

First commission

Available options:
true,
false,
1,
0
filters[refunded]
enum<string>

Refunded reward

Available options:
true,
false,
yes,
no
filters[fraud_check]
enum<string>[]

Referral fraud check (suspicion)

Available options:
no_suspicion,
same_ip_suspicion,
same_promoter_email,
ad_source
filters[plan_id]

Plan id

sorting[sale_amount]
enum<string>

Sort by sale amount

Available options:
asc,
desc
sorting[amount]
enum<string>

Sort by amount

Available options:
asc,
desc
sorting[created_at]
enum<string>

Sort by created_at

Available options:
asc,
desc
sorting[referral]
enum<string>

Sort by referral

Available options:
asc,
desc

Response

Successful response

id
integer
status
enum<string>
Available options:
pending,
approved,
denied
external_note
string | null
created_at
string<date-time>
status_updated_at
string<date-time> | null
promoter_campaign
object
referral
object | null
reward
object
commission_type
enum<string>
Available options:
sale,
custom
sale_amount
number
original_sale_amount
number
original_sale_currency
string | null
plan_id
string | null
tier
integer
unit
string
amount
number
is_paid
boolean