> ## 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/sections/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/sections/categories": {
"get": {
"tags": [
"Sections"
],
"summary": "Get a list of categories",
"description": "Get a list of existing categories.",
"operationId": "GetSectionCategories",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"x-d360-narrative-url": "Get a list of categories
This endpoint retrieves the list of categories available for sections.
A category describes the type of a section and indicates its purpose. For example ground floor, first floor, apartments, parking spaces.
Integrators call this endpoint before inserting or updating a section, to know which category 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 |
|---|
(array item) | string | No | 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. Unlike buildings and complexes, the section categories endpoint returns a plain array of category names, with no associated divisibility flags. |