Skip to content

list_payouts

List channel payouts with optional payout-ID / workspace-ID filtering and Relay pagination (max 25 per page).

Parameter Type Required Description
first number No Number of results to return (forward pagination). Maximum 25. Use with “after” for paging.
after string No Cursor for forward pagination. Pass the “endCursor” from previous page’s pageInfo.
last number No Number of results to return (backward pagination). Maximum 25. Use with “before” for reverse paging.
before string No Cursor for backward pagination. Pass the “startCursor” from previous page’s pageInfo.
filters PayoutsFilters No Filter criteria. Example: { “workspace”: { “id”: { “eq”: “123” } } } or { “id”: { “in”: [“abc”, “def”] } }. - PayoutsFilters
Field Type Required Description
id PayoutIdFilter No Filter by payout ID - PayoutIdFilter
workspace PayoutsWorkspaceFilter No Filter by the payout’s workspace - PayoutsWorkspaceFilter
Field Type Required Description
eq string No Equals: exact ID match
neq string No Not equals: exclude exact ID
in string[] No In: match any ID in the array (empty array matches nothing)
nin string[] No Not in: exclude IDs in the array
Field Type Required Description
id PayoutIdFilter No Filter by workspace ID
Field Type Description
content ContentItem[] Array of content items returned by the tool - ContentItem
isError boolean Whether the tool execution resulted in an error
Field Type Description
type 'text' Content type (currently only ‘text’ is supported)
text string The text content to display