List Payouts

List Payouts

GET /siren/v1/payouts

Returns a paginated list of payouts. Results are wrapped by the ListResponseWrapperInterceptor.

Query Parameters

Parameter	Type	Default	Description
fulfillmentId	integer	—	Filter by parent fulfillment
collaboratorId	integer	—	Filter by collaborator
status	string	—	Filter by payout status (paid, unpaid)
currency	string	—	Filter by currency code
fields	string	core fields	Comma-separated list of fields to include
include	string	—	Legacy: extended to include extra fields
number	integer	10	Results per page
offset	integer	0	Pagination offset
orderBy	string	id	Sort field. Allowed: id, fulfillmentId, collaboratorId, status, value, currency, dateCreated
order	string	DESC	Sort direction: ASC or DESC

This endpoint runs CollaboratorAliasResolverMiddleware to resolve collaborator aliases before filtering. The response includes an x-siren-estimated-count header with the total number of matching records.

Example

GET /siren/v1/payouts?fulfillmentId=5&status=unpaid&fields=id,value,collaboratorName

[
  {
    "id": 20,
    "value": 3000,
    "collaboratorName": "Jane Doe"
  }
]