Skip to main content
GET
List payouts
Each payout comes with a payout statement and, when canDownloadSelfBill is true, a self-billed invoice. Use the payout’s id to download the statement and the invoice. See Payout statements and self-billed invoices.
For a platform: send the business’s id in the AgentaOS-Account header to list that business’s payouts.
Webhook: none.

Authorizations

x-api-key
string
header
required

Your secret key, from app.agentaos.ai -> Settings -> Developers -> API Keys. The key's prefix is both its identity and its environment: sk_test_... (sandbox, free, no verification) or sk_live_... (real money, requires business verification). A missing or invalid key returns 401.

Query Parameters

limit
integer
default:50

Payouts per page.

Required range: x >= 1
offset
integer
default:0

Number of items to skip, for the next page.

Required range: x >= 0

Response

The payouts.

items
object[]