List Obligations

List Obligations

GET /siren/v1/obligations

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

Query Parameters

Parameter	Type	Default	Description
collaboratorId	integer	—	Filter by collaborator ID
status	string	—	Filter by obligation status
awardType	string	—	Filter by award type
payoutId	integer	—	Filter by payout 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, collaboratorId, status, awardType, value, dateCreated
order	string	DESC	Sort direction: ASC or DESC

Middleware

AutoFilterByOwnerMiddleware automatically filters by collaboratorId for collaborator-role users, and CollaboratorAliasResolverMiddleware resolves collaborator aliases before filtering.

Response Headers

The x-siren-estimated-count header returns the total number of matching records.

Example Request

GET /siren/v1/obligations?status=pending&fields=id,status,value,collaboratorName&number=25

Example Response

[
  {
    "id": 10,
    "status": "pending",
    "value": 1500,
    "collaboratorName": "Jane Doe"
  }
]