Siren

List Distributions

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

Last updated: April 9, 2026

GET /siren/v1/distributions

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

Query Parameters:

ParameterTypeDefaultDescription
statusstring—Filter by distribution status
distributorIdinteger—Filter by distributor ID
fieldsstringcore fieldsComma-separated list of fields to include
includestring—Legacy: 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
  }
]

Your privacy choices

Account, checkout and chat you request work without optional tracking. Choose whether to allow these other uses on this website.

You can change or withdraw your choices at any time using “Privacy choices.” We remember your choice for 180 days. Read our privacy policy.