Skip to main content
GET
View pending payouts

Authorizations

x-api-key
string
header
required

API key created in Dashboard → Settings → Developer

Query Parameters

scope
enum<string>
default:company

Choose the data scope. company (default) limits results to the API key company's data. agency includes the parent agency and its linked brands. scope=agency requires a parent agency key; other keys receive 403.

Available options:
company,
agency
page
integer
default:1
limit
integer
default:50
Required range: x <= 100
programId
string

Narrow results to a program

creatorId
string

Narrow results to a creator

creatorHandle
string

Limit results to creators who have a linked social account with exactly this handle, in any letter case. A leading @ is ignored. A handle that no visible creator linked returns an empty result. Use it when you know the handle but not the creatorId.

minAmount
number

Minimum payout in dollars, with at most two decimal places

Required range: x >= 0Must be a multiple of 0.01
sortBy
enum<string>
default:amount
Available options:
amount,
dueDate,
creator
sortOrder
enum<string>
default:desc
Available options:
asc,
desc

Response

200 - application/json

Pending payouts returned successfully

data
object[]
page
integer
limit
integer
total
integer
totalPages
integer
summary
object