Get
/api/v1/realestateobjects/common/energylabels
Get a list of existing energy labels.
Get a list of energy labels
This endpoint retrieves the list of energy labels available in Bloxs.
Integrators call this endpoint before updating an object's energy label, to know which label values are currently configured, since the list is managed in the Bloxs application and can change over time.
Request Fields
This endpoint takes no request parameters.
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
energyLabelName | string | Yes | Energy label value, expressed as a letter grade. Values are configurable in the Bloxs application and cannot be managed through the API. Maximum length 6 characters. |
orderIndex | integer | Yes | Display order of the energy label, starting at 1 for the first entry. |
Security
Responses
200
OK
Array of object
object
energyLabelName
string
Min length1
Max length6
orderIndex
integer (int32)