Siren

Get Program

Returns a single program by ID, with optional extended fields for engagement types and incentive configuration.

Last updated: April 9, 2026

Get Program

GET /siren/v1/programs/{id}

Returns a single program by ID. When no fields parameter is provided, returns the default set: id, name, description, status, units, incentiveType, incentiveResolverType, createdDate, and modifiedDate.

Query Parameters:

ParameterTypeDefaultDescription
fieldsstringcore fieldsComma-separated list of fields to include

Example Request:

GET /siren/v1/programs/1?fields=id,name,status,engagementTypes,incentiveCalculation

Example Response:

{
  "id": 1,
  "name": "Standard Affiliate Program",
  "status": "active",
  "engagementTypes": [
    { "id": 5, "type": "link_click", "value": "100" }
  ],
  "incentiveCalculation": {
    "transactionPercent": "10",
    "payoutPerTransaction": null,
    "payoutPerProduct": null,
    "payoutPerLead": null,
    "activeConversionTypes": ["sale"],
    "autoApprove": "1",
    "leadRequalificationDays": null
  }
}

Error Responses:

  • 404. No record found with that ID.
  • 500. Database error.

Events: Broadcasts ProgramActionEvent (action: Read) after success.