List all commissions
list_commissionsRetrieve a paginated set of commissions for your partner program, filtering by status, type, date, partner, payout, or invoice to track earnings and manage payouts.
Instructions
Retrieve a paginated list of commissions for your partner program.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | The end date of the date range to filter the commissions by. | |
| page | No | DEPRECATED. Use `startingAfter` instead. | |
| type | No | Filter the list of commissions by type. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: - "sale" - "sale,lead" - "-click" | |
| query | No | Filter by lead or sale event metadata. Top-level keys only. Compares string values only — numeric and boolean metadata values are not matched. Examples: - "metadata['key']='value'" - "metadata['key']!='value'" | |
| start | No | The start date of the date range to filter the commissions by. | |
| status | No | Filter the list of commissions 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 commissions by. | createdAt |
| group_id | No | Filter the list of commissions 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" | |
| interval | No | The interval to retrieve commissions for. | all |
| timezone | No | ||
| page_size | No | The number of items per page. | |
| payout_id | No | Filter the list of commissions by the associated payout. | |
| tenant_id | No | Filter the list of commissions by the associated partner's `tenantId` (their unique ID within your database). | |
| invoice_id | No | Filter the list of commissions by the associated invoice. Since invoiceId is unique on a per-program basis, this will only return one commission per invoice. | |
| partner_id | No | Filter the list of commissions by the associated partner. When specified, takes precedence over `tenantId`. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: - "partner_abc" - "partner_abc,partner_xyz" - "-partner_abc" | |
| sort_order | No | The sort order for the list of commissions. | desc |
| customer_id | No | Filter the list of commissions by the associated customer. | |
| ending_before | No | If specified, the query only searches for results before this cursor. Mutually exclusive with `startingAfter`. | |
| partner_tag_id | No | Filter the list of commissions by the associated partner tag. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: - "ptag_abc" - "ptag_abc,ptag_xyz" - "-ptag_abc" | |
| starting_after | No | If specified, the query only searches for results after this cursor. Mutually exclusive with `endingBefore`. | |
| bounty_submission_id | No | Filter the list of commissions by the associated bounty submission. |