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

Prev Next
Get
/api/v1/realestateobjects/complexes/categories

Get a list of existing categories.

Get a list of categories

This endpoint retrieves the list of categories available for complexes.

A category describes the type of a complex and indicates its purpose, and determines whether the complex must be divided into sections.

Integrators call this endpoint before inserting or updating a complex, 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

category

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.

useSections

boolean

Yes

Indicates whether a complex assigned to this category must be divided into sections.

Security
Responses
200

OK

Array of object
object
category
string | null
useSections
boolean