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:
| Parameter | Type | Default | Description |
|---|---|---|---|
status | string | — | Filter by distribution status |
distributorId | integer | — | Filter by distributor ID |
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, status, distributorId, triggerDate, dateCreated |
order | string | DESC | Sort direction: ASC or DESC |
Response Headers:
x-siren-estimated-count. Total matching records (exposed viaAccess-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
}
]