Siren

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:

ParameterTypeDefaultDescription
statusstring—Filter by status
collaboratorIdinteger—Filter by collaborator ID
programIdinteger—Filter by program ID
opportunityIdinteger—Filter by opportunity ID
fieldsstringcore fieldsComma-separated list of fields to include
includestring—Legacy: extended to include extra fields
numberinteger10Results per page
offsetinteger0Pagination offset
orderBystringidSort field
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/engagements?status=active&fields=id,status,score,collaboratorName&number=25

Example Response:

[
  {
    "id": 91,
    "status": "active",
    "score": 100,
    "collaboratorName": "Jane Smith"
  }
]