Siren

Get Obligation

Retrieves a single obligation by ID with optional field selection.

Last updated: April 9, 2026

Get Obligation

GET /siren/v1/obligations/{id}

Returns a single obligation by ID with optional field selection.

Query Parameters

ParameterTypeDefaultDescription
fieldsstringcore fieldsComma-separated list of fields to include
includestringLegacy: extended for all available fields

Example Request

GET /siren/v1/obligations/10?fields=id,status,value,collaboratorName,programName

Example Response

{
  "id": 10,
  "status": "pending",
  "value": 1500,
  "collaboratorName": "Jane Doe",
  "programName": "Standard Affiliate Program"
}

Error Responses

A 404 is returned if no record exists with the given ID. A 500 indicates a database error.