List all payouts
list_payoutsRetrieve a paginated list of partner program payouts, with optional filters for status, partner, group, invoice, and sorting.
Instructions
Retrieve a paginated list of payouts for your partner program.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | The page number for pagination. The first page is `1`. | |
| status | No | Filter the list of payouts by their corresponding status. | |
| account | No | Exact configured private workspace profile label; not a tenant or provider account ID. | |
| sort_by | No | The field to sort the list of payouts by. | amount |
| group_id | No | Filter the list of payouts by the associated partner group. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `group_abc`, `group_abc,group_xyz`, `-group_abc`. | |
| page_size | No | The number of items per page. | |
| tenant_id | No | Filter the list of payouts by the associated partner's `tenantId` (their unique ID within your database). | |
| invoice_id | No | Filter the list of payouts by invoice ID (the unique ID of the invoice you receive for each batch payout you process on Dub). Pending payouts will not have an invoice ID. | |
| partner_id | No | Filter the list of payouts by the associated partner. When specified, takes precedence over `tenantId`. | |
| sort_order | No | The sort order for the list of payouts. | desc |