> ## Documentation Index
> Fetch the complete documentation index at: https://www.bloxs.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a list of energy labels

> Get a list of existing energy labels.

## OpenAPI

````json GET /api/v1/realestateobjects/common/energylabels
{
  "openapi": "3.0.4",
  "info": {
    "title": "RealEstateObjects V1",
    "description": "Welcome to BETA version of the new RealEstateObjects API - intended for client public testing before the launch of the final version. During this BETA phase, we'll be improving the API based on specific client's feedbacks.",
    "version": "v1"
  },
  "security": [
    {}
  ],
  "tags": [
    {
      "name": "Admin"
    },
    {
      "name": "Buildings"
    },
    {
      "name": "Complexes"
    },
    {
      "name": "Generic"
    },
    {
      "name": "Metadata"
    },
    {
      "name": "PublishObjects"
    },
    {
      "name": "ScoringPointTotals"
    },
    {
      "name": "Sections"
    },
    {
      "name": "Units"
    }
  ],
  "paths": {
    "/api/v1/realestateobjects/common/energylabels": {
      "get": {
        "tags": [
          "Admin"
        ],
        "summary": "Get a list of energy labels",
        "description": "Get a list of existing energy labels.",
        "operationId": "GetEnergyLabels",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/EnergyLabelItemAPIModel"
                  }
                }
              }
            }
          }
        },
        "x-d360-narrative-url": "<h3 id=\"get-a-list-of-energy-labels\">Get a list of energy labels</h3><p>This endpoint retrieves the list of energy labels available in Bloxs. </p><p>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.</p><hr class=\"hr-divider1\"><h4 id=\"request-fields\">Request Fields</h4><p>This endpoint takes no request parameters.</p><hr class=\"hr-divider1\"><h4 id=\"response-fields\">Response Fields</h4><div data-type=\"table-content\"><table width=\"100%\" class=\"editor360-table\" borderstyle=\"solid\" bordercollapse=\"collapse\"><colgroup style=\"display: none;\"><col style=\"width: 250px;\"><col style=\"width: 250px;\"><col style=\"width: 250px;\"><col style=\"width: 250px;\"></colgroup><tbody><tr><th colspan=\"1\" rowspan=\"1\"><p>Field</p></th><th colspan=\"1\" rowspan=\"1\"><p>Type</p></th><th colspan=\"1\" rowspan=\"1\"><p>Required</p></th><th colspan=\"1\" rowspan=\"1\"><p>Description</p></th></tr><tr><td colspan=\"1\" rowspan=\"1\"><p>energyLabelName</p></td><td colspan=\"1\" rowspan=\"1\"><p>string</p></td><td colspan=\"1\" rowspan=\"1\"><p>Yes</p></td><td colspan=\"1\" rowspan=\"1\"><p>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.</p></td></tr><tr><td colspan=\"1\" rowspan=\"1\"><p>orderIndex</p></td><td colspan=\"1\" rowspan=\"1\"><p>integer</p></td><td colspan=\"1\" rowspan=\"1\"><p>Yes</p></td><td colspan=\"1\" rowspan=\"1\"><p>Display order of the energy label, starting at 1 for the first entry.</p></td></tr></tbody></table></div><p></p>"
      }
    }
  },
  "components": {
    "schemas": {
      "EnergyLabelItemAPIModel": {
        "required": [
          "energyLabelName"
        ],
        "type": "object",
        "properties": {
          "energyLabelName": {
            "maxLength": 6,
            "minLength": 1,
            "type": "string"
          },
          "orderIndex": {
            "type": "integer",
            "format": "int32"
          }
        },
        "additionalProperties": false
      }
    }
  }
}
````