Get a list of regions
  • 07 Feb 2025
  • 1 Minute to read
  • Dark
    Light

Get a list of regions

  • Dark
    Light

Article summary

Get
/api/v1/realestateobjects/common/regions

[PREVIEW] Get a list of existing regions.

Description

Regions can be assigned to RealEstateObjects (property 'regionName'). However, in order to add the correct region the Bloxs user needs to know which regions are available in the application. This endpoint can be used to retrieve the available regions. 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 regions as an array.

Use Case

By using the Buildings/PUT operation the user wants to edit a building. For this the user wants to include the region in which the building is located. However, the user does not know which options are available as regions. Therefore, the user can use this endpoint to retrieve all available regions.

Security
HTTP
Type Bearer

Please enter a valid token

Responses
200

OK

Array of string
string