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

getLocations

GET
/location
Get all customer locations

Request

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

Responses

🟢200
application/json
successful operation
Bodyapplication/json

🟠400
🟠403
🟠404
🟠429
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/location' \
--header 'X-ApiKey: <api-key>'
Response Response Example
200 - Example 1
[
    {
        "location_name": "As Oy Testikatu 1",
        "location_number": "10000001",
        "business_id": "1234567-1"
    }
]
Modified at 2026-06-18 14:38:42
Next
getLocationByLocationNumber
Built with