Skip to main content
GET
/
v1
/
devices
/
settings
Get Devices Settings
curl --request GET \
  --url https://api.nox.energy/v1/devices/settings \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "device_id": "device_id_123",
      "room": {
        "temperature_lower_bound": 1.5,
        "temperature_upper_bound": 1.5,
        "preferred_temperature": 21,
        "schedule_enabled": true,
        "temperature_control_mode": "auto"
      },
      "dhw": {
        "temperature_upper_bound": 50,
        "temperature_lower_bound": 40
      },
      "optimization_settings": {
        "pv_self_consumption": true,
        "dynamic_tariff": true,
        "flex_trading": false
      },
      "updated_at": "2026-04-17T09:27:09.224000+00:00"
    },
    {
      "device_id": "device_id_456",
      "room": {
        "temperature_lower_bound": 1.5,
        "temperature_upper_bound": 1.5,
        "preferred_temperature": 21,
        "schedule_enabled": true
      },
      "dhw": {
        "temperature_upper_bound": 50,
        "temperature_lower_bound": 40
      },
      "optimization_settings": {
        "pv_self_consumption": true,
        "dynamic_tariff": true,
        "flex_trading": false
      },
      "updated_at": "2026-04-17T09:27:09.224000+00:00"
    }
  ],
  "meta": {
    "energy_supplier": "Energy Supplier A"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.nox.energy/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API Key authentication. Enter your API key in the format: YOUR_API_KEY

Query Parameters

​
device_id
string | null

The ID of the device to filter on. If not provided, all devices are returned.

​
user_id
string | null

The ID of the user to filter on. If not provided, all users are returned.

Response

Successful response for get settings endpoint.

​
data
DevicesGetSettingsRequest · object[]
required

List of device settings

​
metadata
DevicesGetSettingsMetadata · object
required

Metadata related to the device settings response