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 regions

Prev Next
Get
/api/v1/realestateobjects/common/regions

Get a list of existing regions.

Get a list of regions

This endpoint retrieves the list of regions available for buildings.

Integrators call this endpoint before setting a building's regionName, to know which region 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 an available region. The response is a plain array of strings, not an array of objects. Values are configurable in the Bloxs application and cannot be managed through the API.

Security
Responses
200

OK

Array of string
string