Get a list of categories
  • 21 Feb 2025
  • 1 Minute to read
  • Dark
    Light

Get a list of categories

  • Dark
    Light

Article summary

Get
/api/v1/realestateobjects/sections/categories

[PREVIEW] Get a list of existing categories.

Description

Categories can be assigned to RealEstateObjects (property 'categoryName'). The category describes what type of object it concerns and gives an indication of what the purpose of the real estate object is. Examples are: House, office or shop. However, in order to add the correct category the Bloxs user needs to know which categories are available in the application. This endpoint can be used to retrieve the available categories. This is a standard list, however it can be edited by the user in the Bloxs application (not possible through the API).

The response provides the full list of available categories as an array.

Use Case

By using the Sections/PUT the user wants to edit a section. For this the user wants to change the categoryName of the section. However, the user does not know which options are available as categories. Therefore, the user can use this endpoint to retrieve all available categories.

Security
HTTP
Type Bearer

Please enter a valid token

Responses
200

OK

Array of string
string