gridX API Changelog

📚 API Documentation
69

Changelog 2025-10-09T07:19:52.188Z

GET /accounts/{accountID}/systems

  • :warning: added the new ‘2020_DLM_EVS_00’ enum value to the ‘/items/plan’ response property for the response status ‘200’
  • :warning: added the new ‘2020_SLM_EVS_00’ enum value to the ‘/items/plan’ response property for the response status ‘200’

GET /gateways/{gatewayID}

  • :warning: added the new ‘2020_DLM_EVS_00’ enum value to the ‘system/plan’ response property for the response status ‘200’
  • :warning: added the new ‘2020_SLM_EVS_00’ enum value to the ‘system/plan’ response property for the response status ‘200’

GET /systems

  • :warning: added the new ‘2020_DLM_EVS_00’ enum value to the ‘/items/plan’ response property for the response status ‘200’
  • :warning: added the new ‘2020_SLM_EVS_00’ enum value to the ‘/items/plan’ response property for the response status ‘200’

POST /systems

  • :warning: added the new ‘2020_DLM_EVS_00’ enum value to the ‘plan’ response property for the response status ‘201’
  • :warning: added the new ‘2020_SLM_EVS_00’ enum value to the ‘plan’ response property for the response status ‘201’

GET /systems/{systemID}

  • :warning: added the new ‘2020_DLM_EVS_00’ enum value to the ‘plan’ response property for the response status ‘200’
  • :warning: added the new ‘2020_SLM_EVS_00’ enum value to the ‘plan’ response property for the response status ‘200’

PATCH /systems/{systemID}

  • :warning: added the new ‘2020_DLM_EVS_00’ enum value to the ‘plan’ response property for the response status ‘200’
  • :warning: added the new ‘2020_SLM_EVS_00’ enum value to the ‘plan’ response property for the response status ‘200’

(sha f9e3446b)

70

Changelog 2025-10-10T10:24:20.696Z

GET /clusters/{clusterID}/live

  • :warning: api path removed without deprecation

GET /curtailment-clusters/{clusterID}/live

  • endpoint added

(sha 1a4252e1)

71

Changelog 2025-10-16T13:38:12.182Z

GET /clusters/{clusterID}/live

  • :warning: api path removed without deprecation

GET /curtailment-clusters/{clusterID}/live

  • endpoint added

GET /systems

  • added the new optional ‘query’ request parameter ‘includeCounts’
  • added the new optional ‘query’ request parameter ‘limit’
  • added the new optional ‘query’ request parameter ‘offset’
  • added the new optional ‘query’ request parameter ‘sortBy’

GET /systems/{systemID}/assets/{assetID}/measurements

  • added the optional property ‘/items/oneOf[subschema #2: HeaterMeasurement]/status’ to the response with the ‘200’ status

(sha 3a9fedb3)

72

Changelog 2025-10-20T13:34:26.599Z

GET /accounts/{accountID}/systems

  • added the optional property ‘/items/AssetsStatus’ to the response with the ‘200’ status

GET /gateways/{gatewayID}

  • added the optional property ‘system/AssetsStatus’ to the response with the ‘200’ status

GET /systems

  • added the new optional ‘query’ request parameter ‘includeCounts’
  • added the new optional ‘query’ request parameter ‘limit’
  • added the new optional ‘query’ request parameter ‘offset’
  • added the new optional ‘query’ request parameter ‘sortBy’
  • added the optional property ‘/items/AssetsStatus’ to the response with the ‘200’ status

POST /systems

  • added the optional property ‘AssetsStatus’ to the response with the ‘201’ status

GET /systems/{systemID}

  • added the optional property ‘AssetsStatus’ to the response with the ‘200’ status

PATCH /systems/{systemID}

  • added the optional property ‘AssetsStatus’ to the response with the ‘200’ status

GET /systems/{systemID}/assets/{assetID}/measurements

  • :warning: added ‘#/components/schemas/measurements.InverterMeasurement’ to the ‘/items/’ response property ‘oneOf’ list for the response status ‘200’
  • added ‘INVERTER’ mapping keys to the response discriminator for the response status ‘200’
  • added the optional property ‘/items/oneOf[subschema #2: HeaterMeasurement]/status’ to the response with the ‘200’ status

DELETE /systems/{systemID}/gateways/{gatewayID}/export-power-limit

  • added the non-success response with the status ‘400’
  • added the non-success response with the status ‘404’
  • removed the non-success response with the status ‘422’

GET /systems/{systemID}/gateways/{gatewayID}/export-power-limit

  • :warning: removed the media type ‘application/vnd.gridx.v2+json’ for the response with the status ‘200’
  • added the media type ‘application/vnd.gridx.draft+json’ for the response with the status ‘200’
  • added the non-success response with the status ‘400’
  • removed the non-success response with the status ‘403’
  • removed the non-success response with the status ‘422’

PUT /systems/{systemID}/gateways/{gatewayID}/export-power-limit

  • :warning: removed the media type ‘application/vnd.gridx.v2+json’ for the response with the status ‘201’
  • added the media type ‘application/vnd.gridx.draft+json’ for the response with the status ‘201’
  • added the non-success response with the status ‘400’
  • added the non-success response with the status ‘404’
  • removed the non-success response with the status ‘422’

(sha e037db66)

73

Changelog 2025-10-21T12:06:54.422Z

GET /systems/{systemID}/assets/{assetID}/measurements

  • :warning: added ‘#/components/schemas/AssetBatteryMeasurements, #/components/schemas/AssetHeaterMeasurements, #/components/schemas/AssetInverterMeasurements’ to the response body ‘oneOf’ list for the response status ‘200’
  • :warning: the response’s body type/format changed from ‘array’/‘’ to ‘object’/‘’ for status ‘200’
  • mapped value for key ‘BATTERY’ changed from ‘#/components/schemas/measurements.BatteryMeasurement’ to ‘#/components/schemas/AssetBatteryMeasurements’ from the response discriminator for the response status ‘200’
  • mapped value for key ‘HEATER’ changed from ‘#/components/schemas/measurements.HeaterMeasurement’ to ‘#/components/schemas/AssetHeaterMeasurements’ from the response discriminator for the response status ‘200’
  • mapped value for key ‘INVERTER’ changed from ‘#/components/schemas/measurements.InverterMeasurement’ to ‘#/components/schemas/AssetInverterMeasurements’ from the response discriminator for the response status ‘200’

DELETE /systems/{systemID}/gateways/{gatewayID}/export-power-limit

  • added the non-success response with the status ‘400’
  • added the non-success response with the status ‘404’
  • removed the non-success response with the status ‘422’

GET /systems/{systemID}/gateways/{gatewayID}/export-power-limit

  • :warning: removed the media type ‘application/vnd.gridx.v2+json’ for the response with the status ‘200’
  • added the media type ‘application/vnd.gridx.draft+json’ for the response with the status ‘200’
  • added the non-success response with the status ‘400’
  • removed the non-success response with the status ‘403’
  • removed the non-success response with the status ‘422’

PUT /systems/{systemID}/gateways/{gatewayID}/export-power-limit

  • :warning: removed the media type ‘application/vnd.gridx.v2+json’ for the response with the status ‘201’
  • added the media type ‘application/vnd.gridx.draft+json’ for the response with the status ‘201’
  • added the non-success response with the status ‘400’
  • added the non-success response with the status ‘404’
  • removed the non-success response with the status ‘422’

GET /systems/{systemID}/timeofuse/status

  • :warning: added the new ‘EEG_PV_NOMINAL_POWER_NOT_AVAILABLE’ enum value to the ‘periods/items/error_code’ response property for the response status ‘200’

GET /systems/{systemID}/timeofuse/status/current

  • :warning: added the new ‘EEG_PV_NOMINAL_POWER_NOT_AVAILABLE’ enum value to the ‘status/error_code’ response property for the response status ‘200’

(sha 4007a69b)

74

Changelog 2025-10-23T11:17:03.486Z

GET /systems/{systemID}/timeofuse/status

  • :warning: added the new ‘MISSING_PV_NOMINAL_POWER_FOR_CURTAILMENT’ enum value to the ‘periods/items/error_code’ response property for the response status ‘200’
  • removed the ‘EEG_PV_NOMINAL_POWER_NOT_AVAILABLE’ enum value from the ‘periods/items/error_code’ response property for the response status ‘200’

GET /systems/{systemID}/timeofuse/status/current

  • :warning: added the new ‘MISSING_PV_NOMINAL_POWER_FOR_CURTAILMENT’ enum value to the ‘status/error_code’ response property for the response status ‘200’
  • removed the ‘EEG_PV_NOMINAL_POWER_NOT_AVAILABLE’ enum value from the ‘status/error_code’ response property for the response status ‘200’

(sha 0788712b)

75

Changelog 2025-10-28T08:48:16.057Z

GET /systems/{systemID}/timeofuse/status

  • :warning: added the new ‘MISSING_PV_NOMINAL_POWER_FOR_CURTAILMENT’ enum value to the ‘periods/items/error_code’ response property for the response status ‘200’
  • removed the ‘EEG_PV_NOMINAL_POWER_NOT_AVAILABLE’ enum value from the ‘periods/items/error_code’ response property for the response status ‘200’

GET /systems/{systemID}/timeofuse/status/current

  • :warning: added the new ‘MISSING_PV_NOMINAL_POWER_FOR_CURTAILMENT’ enum value to the ‘status/error_code’ response property for the response status ‘200’
  • removed the ‘EEG_PV_NOMINAL_POWER_NOT_AVAILABLE’ enum value from the ‘status/error_code’ response property for the response status ‘200’

(sha d97cef5e)

76

Changelog 2025-10-30T14:28:51.019Z

GET /accounts/{accountID}/systems

  • :warning: added the new ‘UNKNOWN’ enum value to the ‘/items/gateways/items/connectionStatus/status’ response property for the response status ‘200’
  • the ‘/items/gateways/items/startcode’ response’s property pattern ’ [1]{16}$’ was removed for the status ‘200’

GET /gateways

  • :warning: added the new ‘UNKNOWN’ enum value to the ‘/items/connectionStatus/status’ response property for the response status ‘200’
  • the ‘/items/startcode’ response’s property pattern ‘^ [A-F0-9]{16}$’ was removed for the status ‘200’

GET /gateways/{gatewayID}

  • :warning: added the new ‘UNKNOWN’ enum value to the ‘connectionStatus/status’ response property for the response status ‘200’
  • :warning: added the new ‘UNKNOWN’ enum value to the ‘system/gateways/items/connectionStatus/status’ response property for the response status ‘200’
  • the ‘startcode’ response’s property pattern ‘^ [A-F0-9]{16}$’ was removed for the status ‘200’
  • the ‘system/gateways/items/startcode’ response’s property pattern ‘^ [A-F0-9]{16}$’ was removed for the status ‘200’

PATCH /gateways/{gatewayID}

  • :warning: added the new ‘UNKNOWN’ enum value to the ‘connectionStatus/status’ response property for the response status ‘200’
  • the ‘startcode’ response’s property pattern ‘^ [A-F0-9]{16}$’ was removed for the status ‘200’

GET /systems

  • :warning: added the new ‘UNKNOWN’ enum value to the ‘/items/gateways/items/connectionStatus/status’ response property for the response status ‘200’
  • the ‘/items/gateways/items/startcode’ response’s property pattern ‘^ [A-F0-9]{16}$’ was removed for the status ‘200’

POST /systems

  • :warning: added the new ‘UNKNOWN’ enum value to the ‘gateways/items/connectionStatus/status’ response property for the response status ‘201’
  • the ‘gateways/items/startcode’ response’s property pattern ‘^ [A-F0-9]{16}$’ was removed for the status ‘201’

GET /systems/{systemID}

  • :warning: added the new ‘UNKNOWN’ enum value to the ‘gateways/items/connectionStatus/status’ response property for the response status ‘200’
  • the ‘gateways/items/startcode’ response’s property pattern ‘^ [A-F0-9]{16}$’ was removed for the status ‘200’

PATCH /systems/{systemID}

  • :warning: added the new ‘UNKNOWN’ enum value to the ‘gateways/items/connectionStatus/status’ response property for the response status ‘200’
  • the ‘gateways/items/startcode’ response’s property pattern ‘^ [A-F0-9]{16}$’ was removed for the status ‘200’

POST /systems/{systemID}/gateways

  • :warning: added the new ‘UNKNOWN’ enum value to the ‘connectionStatus/status’ response property for the response status ‘201’
  • the ‘startcode’ response’s property pattern ‘^ [A-F0-9]{16}$’ was removed for the status ‘201’

GET /systems/{systemID}/timeofuse/status

  • :warning: added the new ‘INTERNAL_EMPTY_EVCS_DRIVER_CONSTRAINTS’ enum value to the ‘periods/items/error_code’ response property for the response status ‘200’

GET /systems/{systemID}/timeofuse/status/current

  • :warning: added the new ‘INTERNAL_EMPTY_EVCS_DRIVER_CONSTRAINTS’ enum value to the ‘status/error_code’ response property for the response status ‘200’

GET /user/stars/systems

  • :warning: added the new ‘UNKNOWN’ enum value to the ‘/items/gateways/items/connectionStatus/status’ response property for the response status ‘200’

(sha 96c2e30d)

  1. A-F0-9 ↩︎

79

Changelog 2025-11-03T12:33:34.067Z

GET /accounts/{accountID}/groups/{groupID}

  • :warning: removed the optional property ‘users/items/customerID’ from the response with the ‘200’ status

GET /accounts/{accountID}/systems

  • :warning: added the new ‘ADS_TEC_CHARGING_STATION’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’

GET /gateways

  • :warning: added the new ‘ADS_TEC_CHARGING_STATION’ enum value to the ‘/items/scanners/items/’ response property for the response status ‘200’

GET /gateways/{gatewayID}

  • :warning: added the new ‘ADS_TEC_CHARGING_STATION’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘ADS_TEC_CHARGING_STATION’ enum value to the ‘system/gateways/items/scanners/items/’ response property for the response status ‘200’

PATCH /gateways/{gatewayID}

  • :warning: added the new ‘ADS_TEC_CHARGING_STATION’ enum value to the ‘scanners/items/’ response property for the response status ‘200’

GET /gateways/{gatewayID}/appliances

  • added the required property ‘/items/oneOf[subschema #4: EV Charging Station]/kind’ to the response with the ‘200’ status

GET /gateways/{gatewayID}/appliances/{applianceID}

  • added the required property ‘/oneOf[subschema #4: EV Charging Station]/kind’ to the response with the ‘200’ status

PATCH /gateways/{gatewayID}/appliances/{applianceID}

  • added the required property ‘/oneOf[subschema #4: EV Charging Station]/kind’ to the response with the ‘200’ status

GET /gateways/{gatewayID}/scans

  • :warning: added the new ‘ADS_TEC_CHARGING_STATION’ enum value to the ‘/items/scanners/items/name’ response property for the response status ‘200’
  • added the required property ‘/items/appliances/items/oneOf[subschema #4: EV Charging Station]/kind’ to the response with the ‘200’ status

GET /systems

  • :warning: added the new ‘ADS_TEC_CHARGING_STATION’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’

POST /systems

  • :warning: added the new ‘ADS_TEC_CHARGING_STATION’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘201’

GET /systems/{systemID}

  • :warning: added the new ‘ADS_TEC_CHARGING_STATION’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’

PATCH /systems/{systemID}

  • :warning: added the new ‘ADS_TEC_CHARGING_STATION’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’

POST /systems/{systemID}/gateways

  • :warning: added the new ‘ADS_TEC_CHARGING_STATION’ enum value to the ‘scanners/items/’ response property for the response status ‘201’

(sha faac50ba)

80

Changelog 2025-11-06T10:32:21.149Z

GET /account

  • the response optional property ‘kind’ became read-only for the status ‘200’

PATCH /account

  • the response optional property ‘kind’ became read-only for the status ‘200’

GET /accounts

  • the response optional property ‘/items/kind’ became read-only for the status ‘200’

POST /accounts

  • the response optional property ‘kind’ became read-only for the status ‘201’

GET /accounts/{accountID}

  • the response optional property ‘kind’ became read-only for the status ‘200’

PATCH /accounts/{accountID}

  • the response optional property ‘kind’ became read-only for the status ‘200’

GET /accounts/{accountID}/accounts

  • the response optional property ‘/items/kind’ became read-only for the status ‘200’

DELETE /accounts/{accountID}/systems

  • the response optional property ‘kind’ became read-only for the status ‘200’

GET /accounts/{accountID}/systems

  • :warning: added the new ‘WOLF_EEBUS_HEAT_PUMP’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • added the optional property ‘/items/AssetsKinds’ to the response with the ‘200’ status
  • the response optional property ‘/items/accounts/items/kind’ became read-only for the status ‘200’

POST /accounts/{accountID}/systems

  • the response optional property ‘kind’ became read-only for the status ‘200’

GET /accounts/{accountID}/tree

  • the response required property ‘kind’ became read-only for the status ‘200’

GET /customers

  • the response optional property ‘/items/kind’ became read-only for the status ‘200’

GET /customers/{customerID}

  • the response optional property ‘kind’ became read-only for the status ‘200’

PATCH /customers/{customerID}

  • the response optional property ‘kind’ became read-only for the status ‘200’

GET /gateways

  • :warning: added the new ‘WOLF_EEBUS_HEAT_PUMP’ enum value to the ‘/items/scanners/items/’ response property for the response status ‘200’

GET /gateways/{gatewayID}

  • :warning: added the new ‘WOLF_EEBUS_HEAT_PUMP’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘WOLF_EEBUS_HEAT_PUMP’ enum value to the ‘system/gateways/items/scanners/items/’ response property for the response status ‘200’
  • added the optional property ‘system/AssetsKinds’ to the response with the ‘200’ status
  • the response optional property ‘system/accounts/items/kind’ became read-only for the status ‘200’

PATCH /gateways/{gatewayID}

  • :warning: added the new ‘WOLF_EEBUS_HEAT_PUMP’ enum value to the ‘scanners/items/’ response property for the response status ‘200’

GET /gateways/{gatewayID}/scans

  • :warning: added the new ‘WOLF_EEBUS_HEAT_PUMP’ enum value to the ‘/items/scanners/items/name’ response property for the response status ‘200’

GET /systems

  • :warning: added the new ‘WOLF_EEBUS_HEAT_PUMP’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • added the optional property ‘/items/AssetsKinds’ to the response with the ‘200’ status
  • the response optional property ‘/items/accounts/items/kind’ became read-only for the status ‘200’

POST /systems

  • :warning: added the new ‘WOLF_EEBUS_HEAT_PUMP’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘201’
  • added the optional property ‘AssetsKinds’ to the response with the ‘201’ status
  • the response optional property ‘accounts/items/kind’ became read-only for the status ‘201’

GET /systems/{systemID}

  • :warning: added the new ‘WOLF_EEBUS_HEAT_PUMP’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’
  • added the optional property ‘AssetsKinds’ to the response with the ‘200’ status
  • the response optional property ‘accounts/items/kind’ became read-only for the status ‘200’

PATCH /systems/{systemID}

  • :warning: added the new ‘WOLF_EEBUS_HEAT_PUMP’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’
  • added the optional property ‘AssetsKinds’ to the response with the ‘200’ status
  • the response optional property ‘accounts/items/kind’ became read-only for the status ‘200’

GET /systems/{systemID}/assets/{assetID}/measurements

  • :warning: added ‘#/components/schemas/AssetMeterMeasurements’ to the response body ‘oneOf’ list for the response status ‘200’
  • added ‘METER’ mapping keys to the response discriminator for the response status ‘200’

POST /systems/{systemID}/gateways

  • :warning: added the new ‘WOLF_EEBUS_HEAT_PUMP’ enum value to the ‘scanners/items/’ response property for the response status ‘201’

GET /user/stars/accounts

  • the response optional property ‘/items/kind’ became read-only for the status ‘200’

(sha 4571d1b6)

82

Changelog 2025-11-13T11:25:15.234Z

GET /accounts/{accountID}/systems

  • :warning: removed the optional property ‘/items/AssetsKinds’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘/items/AssetsStatus’ from the response with the ‘200’ status
  • added the optional property ‘/items/assetsKinds’ to the response with the ‘200’ status
  • added the optional property ‘/items/assetsStatus’ to the response with the ‘200’ status
  • added the optional property ‘/items/metadata/energy/nominalPower’ to the response with the ‘200’ status

GET /gateways/{gatewayID}

  • :warning: removed the optional property ‘system/AssetsKinds’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘system/AssetsStatus’ from the response with the ‘200’ status
  • added the optional property ‘system/assetsKinds’ to the response with the ‘200’ status
  • added the optional property ‘system/assetsStatus’ to the response with the ‘200’ status
  • added the optional property ‘system/metadata/energy/nominalPower’ to the response with the ‘200’ status

GET /systems

  • :warning: removed the optional property ‘/items/AssetsKinds’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘/items/AssetsStatus’ from the response with the ‘200’ status
  • added the optional property ‘/items/assetsKinds’ to the response with the ‘200’ status
  • added the optional property ‘/items/assetsStatus’ to the response with the ‘200’ status
  • added the optional property ‘/items/metadata/energy/nominalPower’ to the response with the ‘200’ status

POST /systems

  • :warning: removed the optional property ‘AssetsKinds’ from the response with the ‘201’ status
  • :warning: removed the optional property ‘AssetsStatus’ from the response with the ‘201’ status
  • added the optional property ‘assetsKinds’ to the response with the ‘201’ status
  • added the optional property ‘assetsStatus’ to the response with the ‘201’ status
  • added the optional property ‘metadata/energy/nominalPower’ to the response with the ‘201’ status

GET /systems/{systemID}

  • :warning: removed the optional property ‘AssetsKinds’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘AssetsStatus’ from the response with the ‘200’ status
  • added the optional property ‘assetsKinds’ to the response with the ‘200’ status
  • added the optional property ‘assetsStatus’ to the response with the ‘200’ status
  • added the optional property ‘metadata/energy/nominalPower’ to the response with the ‘200’ status

PATCH /systems/{systemID}

  • :warning: removed the optional property ‘AssetsKinds’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘AssetsStatus’ from the response with the ‘200’ status
  • added the optional property ‘assetsKinds’ to the response with the ‘200’ status
  • added the optional property ‘assetsStatus’ to the response with the ‘200’ status
  • added the optional property ‘metadata/energy/nominalPower’ to the response with the ‘200’ status

(sha 55ac1424)

83

Changelog 2025-11-20T09:33:15.797Z

GET /accounts/{accountID}/systems

  • :warning: removed the optional property ‘/items/AssetsKinds’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘/items/AssetsStatus’ from the response with the ‘200’ status
  • added the optional property ‘/items/assetsKinds’ to the response with the ‘200’ status
  • added the optional property ‘/items/assetsStatus’ to the response with the ‘200’ status
  • added the optional property ‘/items/metadata/energy/nominalPower’ to the response with the ‘200’ status
  • added the optional property ‘/items/tags’ to the response with the ‘200’ status

GET /gateways/{gatewayID}

  • :warning: removed the optional property ‘system/AssetsKinds’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘system/AssetsStatus’ from the response with the ‘200’ status
  • added the optional property ‘system/assetsKinds’ to the response with the ‘200’ status
  • added the optional property ‘system/assetsStatus’ to the response with the ‘200’ status
  • added the optional property ‘system/metadata/energy/nominalPower’ to the response with the ‘200’ status
  • added the optional property ‘system/tags’ to the response with the ‘200’ status

GET /systems

  • :warning: removed the optional property ‘/items/AssetsKinds’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘/items/AssetsStatus’ from the response with the ‘200’ status
  • added the optional property ‘/items/assetsKinds’ to the response with the ‘200’ status
  • added the optional property ‘/items/assetsStatus’ to the response with the ‘200’ status
  • added the optional property ‘/items/metadata/energy/nominalPower’ to the response with the ‘200’ status
  • added the optional property ‘/items/tags’ to the response with the ‘200’ status

POST /systems

  • :warning: removed the optional property ‘AssetsKinds’ from the response with the ‘201’ status
  • :warning: removed the optional property ‘AssetsStatus’ from the response with the ‘201’ status
  • added the optional property ‘assetsKinds’ to the response with the ‘201’ status
  • added the optional property ‘assetsStatus’ to the response with the ‘201’ status
  • added the optional property ‘metadata/energy/nominalPower’ to the response with the ‘201’ status
  • added the optional property ‘tags’ to the response with the ‘201’ status

GET /systems/{systemID}

  • :warning: removed the optional property ‘AssetsKinds’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘AssetsStatus’ from the response with the ‘200’ status
  • added the optional property ‘assetsKinds’ to the response with the ‘200’ status
  • added the optional property ‘assetsStatus’ to the response with the ‘200’ status
  • added the optional property ‘metadata/energy/nominalPower’ to the response with the ‘200’ status
  • added the optional property ‘tags’ to the response with the ‘200’ status

PATCH /systems/{systemID}

  • :warning: removed the optional property ‘AssetsKinds’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘AssetsStatus’ from the response with the ‘200’ status
  • added the optional property ‘assetsKinds’ to the response with the ‘200’ status
  • added the optional property ‘assetsStatus’ to the response with the ‘200’ status
  • added the optional property ‘metadata/energy/nominalPower’ to the response with the ‘200’ status
  • added the optional property ‘tags’ to the response with the ‘200’ status

GET /systems/{systemID}/assets/{assetID}/measurements

  • :warning: added ‘#/components/schemas/AssetHeatPumpMeasurements’ to the response body ‘oneOf’ list for the response status ‘200’
  • added ‘HEAT_PUMP’ mapping keys to the response discriminator for the response status ‘200’

(sha 12e8a744)

84

Changelog 2025-11-25T17:43:58.211Z

GET /accounts/{accountID}/systems

  • added the optional property ‘/items/tags’ to the response with the ‘200’ status

GET /gateways/{gatewayID}

  • added the optional property ‘system/tags’ to the response with the ‘200’ status

GET /systems

  • added the optional property ‘/items/tags’ to the response with the ‘200’ status

POST /systems

  • added the optional property ‘tags’ to the response with the ‘201’ status

GET /systems/{systemID}

  • added the optional property ‘tags’ to the response with the ‘200’ status

PATCH /systems/{systemID}

  • added the optional property ‘tags’ to the response with the ‘200’ status

GET /systems/{systemID}/assets/{assetID}/measurements

  • :warning: added ‘#/components/schemas/AssetHeatPumpMeasurements’ to the response body ‘oneOf’ list for the response status ‘200’
  • added ‘HEAT_PUMP’ mapping keys to the response discriminator for the response status ‘200’

(sha d1dd7a96)

85

Changelog 2025-12-02T14:03:00.194Z

GET /systems/{systemID}/assets/{assetID}/measurements

  • :warning: added ‘#/components/schemas/AssetEVChargingStationMeasurements’ to the response body ‘oneOf’ list for the response status ‘200’
  • added ‘EV_CHARGING_STATION’ mapping keys to the response discriminator for the response status ‘200’

(sha f5f2ab16)

86

Changelog 2025-12-17T13:33:18.085Z

GET /accounts/{accountID}/systems

  • :warning: added the new ‘ENA_G100’ enum value to the ‘/items/metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘SHELLY_3EMPRO_HTTP_METER’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘SHELLY_PRO2_HTTP_IO_DEVICE’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’

GET /gateways

  • :warning: added the new ‘SHELLY_3EMPRO_HTTP_METER’ enum value to the ‘/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘SHELLY_PRO2_HTTP_IO_DEVICE’ enum value to the ‘/items/scanners/items/’ response property for the response status ‘200’

GET /gateways/{gatewayID}

  • :warning: added the new ‘ENA_G100’ enum value to the ‘system/metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘SHELLY_3EMPRO_HTTP_METER’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘SHELLY_3EMPRO_HTTP_METER’ enum value to the ‘system/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘SHELLY_PRO2_HTTP_IO_DEVICE’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘SHELLY_PRO2_HTTP_IO_DEVICE’ enum value to the ‘system/gateways/items/scanners/items/’ response property for the response status ‘200’

PATCH /gateways/{gatewayID}

  • :warning: added the new ‘SHELLY_3EMPRO_HTTP_METER’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘SHELLY_PRO2_HTTP_IO_DEVICE’ enum value to the ‘scanners/items/’ response property for the response status ‘200’

GET /gateways/{gatewayID}/scans

  • :warning: added the new ‘SHELLY_3EMPRO_HTTP_METER’ enum value to the ‘/items/scanners/items/name’ response property for the response status ‘200’
  • :warning: added the new ‘SHELLY_PRO2_HTTP_IO_DEVICE’ enum value to the ‘/items/scanners/items/name’ response property for the response status ‘200’

GET /systems

  • :warning: added the new ‘ENA_G100’ enum value to the ‘/items/metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘SHELLY_3EMPRO_HTTP_METER’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘SHELLY_PRO2_HTTP_IO_DEVICE’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’

POST /systems

  • :warning: added the new ‘ENA_G100’ enum value to the ‘metadata/wizard/step’ response property for the response status ‘201’
  • :warning: added the new ‘SHELLY_3EMPRO_HTTP_METER’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘201’
  • :warning: added the new ‘SHELLY_PRO2_HTTP_IO_DEVICE’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘201’

GET /systems/{systemID}

  • :warning: added the new ‘ENA_G100’ enum value to the ‘metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘SHELLY_3EMPRO_HTTP_METER’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘SHELLY_PRO2_HTTP_IO_DEVICE’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’

PATCH /systems/{systemID}

  • :warning: added the new ‘ENA_G100’ enum value to the ‘metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘SHELLY_3EMPRO_HTTP_METER’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘SHELLY_PRO2_HTTP_IO_DEVICE’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’

POST /systems/{systemID}/gateways

  • :warning: added the new ‘SHELLY_3EMPRO_HTTP_METER’ enum value to the ‘scanners/items/’ response property for the response status ‘201’
  • :warning: added the new ‘SHELLY_PRO2_HTTP_IO_DEVICE’ enum value to the ‘scanners/items/’ response property for the response status ‘201’

GET /systems/{systemID}/tariff

  • :warning: added the new ‘DYNAMIC’ enum value to the ‘feedinType’ response property for the response status ‘200’

PATCH /systems/{systemID}/tariff

  • :warning: added the new ‘DYNAMIC’ enum value to the ‘feedinType’ response property for the response status ‘200’

POST /systems/{systemID}/tariff

  • :warning: added the new ‘DYNAMIC’ enum value to the ‘feedinType’ response property for the response status ‘201’

GET /systems/{systemID}/timeofuse/decisions

  • :warning: added the new ‘EV_CHARGE_IN_EXPECTED_SURPLUS’ enum value to the ‘decisions/items/insight/motives/items/’ response property for the response status ‘200’

(sha 6695de20)

87

Changelog 2025-12-17T13:46:01.357Z

GET /accounts/{accountID}/systems

  • :warning: added the new ‘SHELLY_3EMPRO_HTTP_METER’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘SHELLY_PRO2_HTTP_IO_DEVICE’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’

GET /accounts/{accountID}/users/{userID}/notifications

  • api path removed with deprecation

POST /accounts/{accountID}/users/{userID}/notifications

  • api path removed with deprecation

GET /accounts/{accountID}/users/{userID}/notifications/rules

  • api path removed with deprecation

POST /accounts/{accountID}/users/{userID}/notifications/rules

  • api path removed with deprecation

DELETE /accounts/{accountID}/users/{userID}/notifications/rules/{ruleID}

  • api path removed with deprecation

GET /accounts/{accountID}/users/{userID}/notifications/rules/{ruleID}

  • api path removed with deprecation

PUT /accounts/{accountID}/users/{userID}/notifications/rules/{ruleID}

  • api path removed with deprecation

DELETE /accounts/{accountID}/users/{userID}/notifications/{notificationID}

  • api path removed with deprecation

GET /accounts/{accountID}/users/{userID}/notifications/{notificationID}

  • api path removed with deprecation

PUT /accounts/{accountID}/users/{userID}/notifications/{notificationID}

  • api path removed with deprecation

GET /gateways

  • :warning: added the new ‘SHELLY_3EMPRO_HTTP_METER’ enum value to the ‘/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘SHELLY_PRO2_HTTP_IO_DEVICE’ enum value to the ‘/items/scanners/items/’ response property for the response status ‘200’

GET /gateways/{gatewayID}

  • :warning: added the new ‘SHELLY_3EMPRO_HTTP_METER’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘SHELLY_3EMPRO_HTTP_METER’ enum value to the ‘system/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘SHELLY_PRO2_HTTP_IO_DEVICE’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘SHELLY_PRO2_HTTP_IO_DEVICE’ enum value to the ‘system/gateways/items/scanners/items/’ response property for the response status ‘200’

PATCH /gateways/{gatewayID}

  • :warning: added the new ‘SHELLY_3EMPRO_HTTP_METER’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘SHELLY_PRO2_HTTP_IO_DEVICE’ enum value to the ‘scanners/items/’ response property for the response status ‘200’

GET /gateways/{gatewayID}/scans

  • :warning: added the new ‘SHELLY_3EMPRO_HTTP_METER’ enum value to the ‘/items/scanners/items/name’ response property for the response status ‘200’
  • :warning: added the new ‘SHELLY_PRO2_HTTP_IO_DEVICE’ enum value to the ‘/items/scanners/items/name’ response property for the response status ‘200’

GET /systems

  • :warning: added the new ‘SHELLY_3EMPRO_HTTP_METER’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘SHELLY_PRO2_HTTP_IO_DEVICE’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’

POST /systems

  • :warning: added the new ‘SHELLY_3EMPRO_HTTP_METER’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘201’
  • :warning: added the new ‘SHELLY_PRO2_HTTP_IO_DEVICE’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘201’

GET /systems/{systemID}

  • :warning: added the new ‘SHELLY_3EMPRO_HTTP_METER’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘SHELLY_PRO2_HTTP_IO_DEVICE’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’

PATCH /systems/{systemID}

  • :warning: added the new ‘SHELLY_3EMPRO_HTTP_METER’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘SHELLY_PRO2_HTTP_IO_DEVICE’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’

POST /systems/{systemID}/gateways

  • :warning: added the new ‘SHELLY_3EMPRO_HTTP_METER’ enum value to the ‘scanners/items/’ response property for the response status ‘201’
  • :warning: added the new ‘SHELLY_PRO2_HTTP_IO_DEVICE’ enum value to the ‘scanners/items/’ response property for the response status ‘201’

GET /systems/{systemID}/tariff

  • :warning: added the new ‘DYNAMIC’ enum value to the ‘feedinType’ response property for the response status ‘200’

PATCH /systems/{systemID}/tariff

  • :warning: added the new ‘DYNAMIC’ enum value to the ‘feedinType’ response property for the response status ‘200’

POST /systems/{systemID}/tariff

  • :warning: added the new ‘DYNAMIC’ enum value to the ‘feedinType’ response property for the response status ‘201’

GET /systems/{systemID}/timeofuse/decisions

  • :warning: added the new ‘EV_CHARGE_IN_EXPECTED_SURPLUS’ enum value to the ‘decisions/items/insight/motives/items/’ response property for the response status ‘200’

(sha fb04ae4a)

88

Changelog 2025-12-22T14:44:01.764Z

GET /accounts/{accountID}/systems

  • added the new optional ‘query’ request parameter ‘includeCounts’
  • added the new optional ‘query’ request parameter ‘limit’
  • added the new optional ‘query’ request parameter ‘offset’
  • added the new optional ‘query’ request parameter ‘sortBy’

(sha d02180b7)

89

Changelog 2026-01-07T14:25:39.051Z

GET /accounts/{accountID}/systems

  • added the new optional ‘query’ request parameter ‘includeCounts’
  • added the new optional ‘query’ request parameter ‘limit’
  • added the new optional ‘query’ request parameter ‘offset’
  • added the new optional ‘query’ request parameter ‘sortBy’

GET /gateways/{gatewayID}/appliances

  • :warning: the response property ‘/items/oneOf[subschema #3: Heat Pump]/heatPump/withOwnTariff’ became optional for the status ‘200’

GET /gateways/{gatewayID}/appliances/{applianceID}

  • :warning: the response property ‘/oneOf[subschema #3: Heat Pump]/heatPump/withOwnTariff’ became optional for the status ‘200’

PATCH /gateways/{gatewayID}/appliances/{applianceID}

  • :warning: the response property ‘/oneOf[subschema #3: Heat Pump]/heatPump/withOwnTariff’ became optional for the status ‘200’

GET /gateways/{gatewayID}/scans

  • :warning: the response property ‘/items/appliances/items/oneOf[subschema #3: Heat Pump]/heatPump/withOwnTariff’ became optional for the status ‘200’

GET /systems/{systemID}/ev-profiles

  • added the optional property ‘/items/phaseSwitchFeatureEnabled’ to the response with the ‘200’ status

POST /systems/{systemID}/ev-profiles

  • added the optional property ‘phaseSwitchFeatureEnabled’ to the response with the ‘201’ status

GET /systems/{systemID}/ev-profiles/{evProfileID}

  • added the optional property ‘phaseSwitchFeatureEnabled’ to the response with the ‘200’ status

PATCH /systems/{systemID}/ev-profiles/{evProfileID}

  • added the new optional request property ‘phaseSwitchFeatureEnabled’
  • added the optional property ‘phaseSwitchFeatureEnabled’ to the response with the ‘200’ status

(sha 673afbf5)

90

Changelog 2026-01-12T10:49:46.259Z

GET /accounts/{accountID}/systems

  • added the new optional ‘query’ request parameter ‘filterBy’
  • added the optional property ‘/items/metadata/energy/ems/enabledPowerWindowHysteresis’ to the response with the ‘200’ status
  • added the optional property ‘/items/metadata/energy/ems/powerImportPeakPerOptimizationIntervalmVA’ to the response with the ‘200’ status

GET /gateways/{gatewayID}

  • added the optional property ‘system/metadata/energy/ems/enabledPowerWindowHysteresis’ to the response with the ‘200’ status
  • added the optional property ‘system/metadata/energy/ems/powerImportPeakPerOptimizationIntervalmVA’ to the response with the ‘200’ status

GET /gateways/{gatewayID}/appliances

  • :warning: the response property ‘/items/oneOf[subschema #3: Heat Pump]/heatPump/withOwnTariff’ became optional for the status ‘200’

GET /gateways/{gatewayID}/appliances/{applianceID}

  • :warning: the response property ‘/oneOf[subschema #3: Heat Pump]/heatPump/withOwnTariff’ became optional for the status ‘200’

PATCH /gateways/{gatewayID}/appliances/{applianceID}

  • :warning: the response property ‘/oneOf[subschema #3: Heat Pump]/heatPump/withOwnTariff’ became optional for the status ‘200’

GET /gateways/{gatewayID}/scans

  • :warning: the response property ‘/items/appliances/items/oneOf[subschema #3: Heat Pump]/heatPump/withOwnTariff’ became optional for the status ‘200’

GET /systems

  • added the new optional ‘query’ request parameter ‘filterBy’
  • added the optional property ‘/items/metadata/energy/ems/enabledPowerWindowHysteresis’ to the response with the ‘200’ status
  • added the optional property ‘/items/metadata/energy/ems/powerImportPeakPerOptimizationIntervalmVA’ to the response with the ‘200’ status

POST /systems

  • added the optional property ‘metadata/energy/ems/enabledPowerWindowHysteresis’ to the response with the ‘201’ status
  • added the optional property ‘metadata/energy/ems/powerImportPeakPerOptimizationIntervalmVA’ to the response with the ‘201’ status

GET /systems/{systemID}

  • added the optional property ‘metadata/energy/ems/enabledPowerWindowHysteresis’ to the response with the ‘200’ status
  • added the optional property ‘metadata/energy/ems/powerImportPeakPerOptimizationIntervalmVA’ to the response with the ‘200’ status

PATCH /systems/{systemID}

  • added the optional property ‘metadata/energy/ems/enabledPowerWindowHysteresis’ to the response with the ‘200’ status
  • added the optional property ‘metadata/energy/ems/powerImportPeakPerOptimizationIntervalmVA’ to the response with the ‘200’ status

GET /systems/{systemID}/ev-profiles

  • added the optional property ‘/items/phaseSwitchFeatureEnabled’ to the response with the ‘200’ status

POST /systems/{systemID}/ev-profiles

  • added the optional property ‘phaseSwitchFeatureEnabled’ to the response with the ‘201’ status

GET /systems/{systemID}/ev-profiles/{evProfileID}

  • added the optional property ‘phaseSwitchFeatureEnabled’ to the response with the ‘200’ status

PATCH /systems/{systemID}/ev-profiles/{evProfileID}

  • added the new optional request property ‘phaseSwitchFeatureEnabled’
  • added the optional property ‘phaseSwitchFeatureEnabled’ to the response with the ‘200’ status

(sha 4fe4eb5e)

91

Changelog 2026-01-21T08:43:02.356Z

GET /accounts/{accountID}/systems

  • added the new optional ‘query’ request parameter ‘filterBy’
  • added the optional property ‘/items/metadata/energy/ems/enabledPowerWindowHysteresis’ to the response with the ‘200’ status
  • added the optional property ‘/items/metadata/energy/ems/powerImportPeakPerOptimizationIntervalmVA’ to the response with the ‘200’ status

GET /gateways/{gatewayID}

  • added the optional property ‘system/metadata/energy/ems/enabledPowerWindowHysteresis’ to the response with the ‘200’ status
  • added the optional property ‘system/metadata/energy/ems/powerImportPeakPerOptimizationIntervalmVA’ to the response with the ‘200’ status

GET /gateways/{gatewayID}/appliances

  • :warning: added ‘#/components/schemas/EV’ to the ‘/items/’ response property ‘oneOf’ list for the response status ‘200’
  • added ‘EV’ discriminator mapping keys to the ‘/items/’ response property for the response status ‘200’

GET /gateways/{gatewayID}/appliances/{applianceID}

  • :warning: added ‘#/components/schemas/EV’ to the response body ‘oneOf’ list for the response status ‘200’
  • added ‘EV’ mapping keys to the response discriminator for the response status ‘200’

PATCH /gateways/{gatewayID}/appliances/{applianceID}

  • :warning: added ‘#/components/schemas/EV’ to the response body ‘oneOf’ list for the response status ‘200’
  • added ‘EV’ mapping keys to the response discriminator for the response status ‘200’

DELETE /gateways/{gatewayID}/appliances/{applianceID}/outputs

  • endpoint added

GET /gateways/{gatewayID}/scans

  • :warning: added ‘#/components/schemas/EV’ to the ‘/items/appliances/items/’ response property ‘oneOf’ list for the response status ‘200’
  • added ‘EV’ discriminator mapping keys to the ‘/items/appliances/items/’ response property for the response status ‘200’

GET /systems

  • added the new optional ‘query’ request parameter ‘filterBy’
  • added the optional property ‘/items/metadata/energy/ems/enabledPowerWindowHysteresis’ to the response with the ‘200’ status
  • added the optional property ‘/items/metadata/energy/ems/powerImportPeakPerOptimizationIntervalmVA’ to the response with the ‘200’ status

POST /systems

  • added the optional property ‘metadata/energy/ems/enabledPowerWindowHysteresis’ to the response with the ‘201’ status
  • added the optional property ‘metadata/energy/ems/powerImportPeakPerOptimizationIntervalmVA’ to the response with the ‘201’ status

GET /systems/{systemID}

  • added the optional property ‘metadata/energy/ems/enabledPowerWindowHysteresis’ to the response with the ‘200’ status
  • added the optional property ‘metadata/energy/ems/powerImportPeakPerOptimizationIntervalmVA’ to the response with the ‘200’ status

PATCH /systems/{systemID}

  • added the optional property ‘metadata/energy/ems/enabledPowerWindowHysteresis’ to the response with the ‘200’ status
  • added the optional property ‘metadata/energy/ems/powerImportPeakPerOptimizationIntervalmVA’ to the response with the ‘200’ status

(sha b5806d7d)