> ## 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 categories

> Get a list of existing categories.

## OpenAPI

````json GET /api/v1/realestateobjects/units/categories
{
  "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/units/categories": {
      "get": {
        "tags": [
          "Units"
        ],
        "summary": "Get a list of categories",
        "description": "Get a list of existing categories.",
        "operationId": "GetUnitCategories",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/RentableObjectCategoryAPIModel"
                  }
                }
              }
            }
          }
        },
        "x-d360-narrative-url": "<h3 id=\"get-a-list-of-categories\">Get a list of categories</h3><p>This endpoint retrieves the list of categories available for units. </p><p>A category describes the type of a unit and indicates its purpose, and determines the unit's divisibility rules. </p><p>Integrators call this endpoint before inserting or updating a unit, to know which category 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>category</p></td><td colspan=\"1\" rowspan=\"1\"><p>string</p></td><td colspan=\"1\" rowspan=\"1\"><p>No</p></td><td colspan=\"1\" rowspan=\"1\"><p>Name of the category, for example house, office, or shop. Category values are configurable in the Bloxs application and cannot be managed through the API.</p></td></tr><tr><td colspan=\"1\" rowspan=\"1\"><p>divisibleType</p></td><td colspan=\"1\" rowspan=\"1\"><p>integer</p></td><td colspan=\"1\" rowspan=\"1\"><p>No</p></td><td colspan=\"1\" rowspan=\"1\"><p>Divisibility rule tied to this category. Valid values are 1 (SingleUnit), 2 (DivisibleByUnits), or 3 (DivisibleByFloorArea).</p></td></tr></tbody></table></div><p></p>"
      }
    }
  },
  "components": {
    "schemas": {
      "RentableObjectCategoryAPIModel": {
        "type": "object",
        "properties": {
          "category": {
            "type": "string",
            "nullable": true
          },
          "divisibleType": {
            "type": "integer",
            "description": "SingleUnit = 1\nDivisibleByUnits = 2\nDivisibleByFloorArea = 3",
            "format": "int32",
            "nullable": true,
            "x-enumNames": [
              "SingleUnit",
              "DivisibleByUnits",
              "DivisibleByFloorArea"
            ]
          }
        },
        "additionalProperties": false
      }
    }
  }
}
````