List Fulfillments
Returns a paginated list of fulfillments with filtering, sorting, and field selection.
Last updated: April 9, 2026
List Fulfillments
GET /siren/v1/fulfillments
Returns a paginated list of fulfillments. Results are wrapped by the ListResponseWrapperInterceptor.
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
status | string | — | Filter by fulfillment status |
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, dateCreated |
order | string | DESC | Sort direction: ASC or DESC |
The response includes an x-siren-estimated-count header with the total number of matching records.
Example
GET /siren/v1/fulfillments?status=pending&fields=id,status,payoutCount,totalValue
[
{
"id": 5,
"status": "pending",
"payoutCount": 12,
"totalValue": 45000
}
]