Skip to main content
GET
Get all payouts grouped by promoters

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 'promoter.profile.first_name,promoter.profile.last_name,promoter.user.email`

filters[status]
enum<string>

Filter by status

Available options:
pending,
completed,
failed,
processing,
cancelled
filters[campaign_id]

Campaign ids. Can be Integer or Array of Integers

include_payout_method_details
boolean

Set it true to include the payout_method_details

filters[min_payment]
integer

Filters payouts by the minimum payment amount possible

filters[invoiceable]
enum<string>

Filters payouts by invoiceable

Available options:
true,
false,
not_set

Response

Successful response

data
object[]
meta
object