v1

latestOpenAPI 3.0.02026-07-264731126.7 KB

Get all payouts grouped by promoters

This endpoint returns all payouts but grouped by promoters. <Tip>HTTP Request <br/>GET https://api.firstpromoter.com/api/v2/company/payouts/group_by_promoters</Tip>

get/payouts/group_by_promoters

Query parameters

qstring

Search params. Searches by 'promoter.profile.first_name, promoter.profile.last_name, promoter.user.email`

filters[status]'pending' | 'completed' | 'failed' | 'processing' | 'cancelled'

Filter by status

integer

integer[]

Campaign ids. Can be Integer or Array of Integers

include_payout_method_detailsboolean

Set it true to include the payout_method_details

filters[min_payment]integer

Filters payouts by the minimum payment amount possible

filters[invoiceable]'true' | 'false' | 'not_set'

Filters payouts by invoiceable

Headers

Account-IDstring required

Account id. You can find your Account ID on Your FirstPromoter Dashboard. Navigate to Settings → Integrations

Response

Successful response