Skip to main content
GET
Get pending payouts

Authorizations

x-api-key
string
header
required

API key for authentication. Get yours from Settings → Integrations. A key created by a team member acts as that member and follows their current team permissions; a request outside those permissions returns 403 { "error": "insufficient_scope", "scope": "<required>" }.

Query Parameters

page
integer
default:1
limit
integer
default:50
Required range: x <= 100
programId
string

Filter by specific program

creatorId
string

Filter by specific creator

minAmount
number

Leaves out the rows whose totalAmount is less than this (in dollars)

sortBy
enum<string>
default:amount
Available options:
amount,
dueDate,
creator
sortOrder
enum<string>
default:desc
Available options:
asc,
desc

Response

200 - application/json

Successfully retrieved pending payouts

data
object[]
page
integer
limit
integer
total
integer

Every listed row, the rows that owe only Growth too

totalPages
integer
summary
object

Totals over every row, not only the page. The counts and totalAmount are of the rows that owe work (amount more than 0); totalGrowth and totalOwed are of every row.