> ## 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
> Get a list of existing regions.
## OpenAPI
````json GET /api/v1/realestateobjects/common/regions
{
"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/common/regions": {
"get": {
"tags": [
"Admin"
],
"summary": "Get a list of regions",
"description": "Get a list of existing regions.",
"operationId": "GetRegions",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"x-d360-narrative-url": "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. |