1. heating
Residentia REST API
  • Residentia REST API
    • location
      • getLocations
      • getLocationByLocationNumber
    • sensor
      • getSensorBySensorId
      • getSensorHistoryBySensorId
    • overdrive
      • setOverdriveSettings
      • getOverdriveSettings
      • getOneLocationOverdriveSettings
      • getLocationOverdriveStatus
    • consumption_report
      • getMonthlyConsumption
      • getDailyConsumption
      • getDistrictHeating
      • specificEnergyConsumption
    • heating
      • getLocationHeatingCurve
        GET
      • getLocationTargetSetpoint
        GET
    • Schemas
      • LocationItem
      • LocationSensorItem
      • SensorItem
      • SensorHistoryItem
      • HistoryData
      • OverdriveBody
      • Overdrive
      • OverdrivePostResponse
      • OverdriveGetResponse
      • HeatingCurvePoint
      • HeatingCurveItem
      • TargetSetpointItem
      • OverdriveStatusItem
      • MonthlyConsumptionItem
      • SpecificEnergyTypeResult
  1. heating

getLocationTargetSetpoint

GET
/location/{location_number}/target_setpoint
Latest control state per heating circuit. Temperature fields are controller setpoints in °C, not raw valve values. stale is true when the latest sample is older than 300 s or missing; a circuit with no telemetry in the window is still listed, with null values and stale: true.

Request

Authorization
API Key
Add parameter in header
X-ApiKey
Example:
X-ApiKey: ********************
or
Path Params

Responses

🟢200
application/json
successful operation
Bodyapplication/json

🟠400
🟠403
🟠404
🟠429
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/location/10000001/target_setpoint' \
--header 'X-ApiKey: <api-key>'
Response Response Example
200 - Example 1
[
    {
        "circuit_id": 42,
        "target_supply_setpoint": 55.3,
        "curve_value": 54.1,
        "outdoor_temp": -3.2,
        "current_supply": 54.8,
        "updated_at": "2026-06-08T09:19:31.000Z",
        "stale": false
    }
]
Modified at 2026-06-18 14:38:42
Previous
getLocationHeatingCurve
Next
LocationItem
Built with