Siren

List Distributions

Returns a paginated list of distributions with support for filtering by status and distributor.

Last updated: April 9, 2026

List Distributions

GET /siren/v1/distributions

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

Query Parameters:

ParameterTypeDefaultDescription
statusstringFilter by distribution status
distributorIdintegerFilter by distributor ID
fieldsstringcore fieldsComma-separated list of fields to include
includestringLegacy: extended to include extra fields
numberinteger10Results per page
offsetinteger0Pagination offset
orderBystringidSort field. Allowed: id, status, distributorId, triggerDate, dateCreated
orderstringDESCSort direction: ASC or DESC

Response Headers:

  • x-siren-estimated-count. Total matching records (exposed via Access-Control-Expose-Headers).

Example Request:

GET /siren/v1/distributions?status=pending&fields=id,status,distributorName,value&number=25

Example Response:

[
  {
    "id": 18,
    "status": "pending",
    "distributorName": "Monthly Payouts",
    "value": 5000
  }
]