List Engagements
Retrieve a paginated list of engagements with filtering and field selection.
Last updated: April 9, 2026
List Engagements
GET /siren/v1/engagements
Returns a paginated list of engagements. Results are wrapped by the ListResponseWrapperInterceptor.
Query Parameters:
| Parameter | Type | Default | Description |
|---|---|---|---|
status | string | — | Filter by status |
collaboratorId | integer | — | Filter by collaborator ID |
programId | integer | — | Filter by program ID |
opportunityId | integer | — | Filter by opportunity 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 |
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/engagements?status=active&fields=id,status,score,collaboratorName&number=25
Example Response:
[
{
"id": 91,
"status": "active",
"score": 100,
"collaboratorName": "Jane Smith"
}
]