Siren

List Programs

Returns a paginated list of programs, with support for filtering by status, incentive type, currency, and program group.

Last updated: April 9, 2026

List Programs

GET /siren/v1/programs

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

Query Parameters:

ParameterTypeDefaultDescription
fieldsstringComma-separated list of fields to include (required)
statusstringFilter by status
incentiveTypestringFilter by incentive type
incentiveResolverTypestringFilter by incentive resolver type
unitsstringFilter by currency unit
programGroupIdintegerFilter to programs belonging to a specific program group
sstringSearch across name and description
numberinteger10Results per page
offsetinteger0Pagination offset
orderBystringidSort field
orderstringASCSort direction: ASC or DESC

Response Headers:

  • x-siren-estimated-count. Total matching records (exposed via Access-Control-Expose-Headers).

Example Request:

GET /siren/v1/programs?fields=id,name,status,collaboratorCount&status=active&number=25

Example Response:

[
  {
    "id": 1,
    "name": "Standard Affiliate Program",
    "status": "active",
    "collaboratorCount": 12
  }
]