> ## 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 building > Get an existing building. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the building. ## OpenAPI ````json GET /api/v1/realestateobjects/buildings { "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/buildings": { "get": { "tags": [ "Buildings" ], "summary": "Get a building", "description": "Get an existing building. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the building.", "operationId": "GetBuilding", "parameters": [ { "name": "reference", "in": "query", "description": "The internal identifier of the model (i.e. Reference, Code, Name, depends on model).", "schema": { "type": "string" } }, { "name": "externalIdentifier", "in": "query", "description": "The external API identifier of the model.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuildingAPIDetailModel" } } } }, "404": { "description": "The requested building was not found." } }, "x-d360-narrative-url": "

Get a building

This endpoint retrieves the full detail record of an existing building.

Integrators call it to look up a single standalone rentable object, such as a row house, before displaying, syncing, or updating its data in an external system.

The building can be identified by its internal reference, its external identifier, or both.

Request Fields

Field

Type

Required

Description

reference

string

Conditional

Internal identifier of the building. Either reference or externalIdentifier must be provided. If both are given, the building must match both values.

externalIdentifier

string

Conditional

External identifier of the building, as set by the integrating system. Either reference or externalIdentifier must be provided. If both are given, the building must match both values.

Response Fields

Field

Type

Required

Description

reference

string

No

Internal identifier of the building.

externalIdentifier

string

No

External identifier of the building, as set by the integrating system.

name

string

No

Name of the building.

displayName

string

No

Display name of the building, as shown in Bloxs.

ownerReference

string

No

Reference of the owner the building belongs to.

categoryName

string

No

Category assigned to the building. The category describes the type of object and indicates its purpose, for example house, office, or shop. Category values are configurable in the Bloxs admin module and determine the divisibility rules of the building.

extraRelations

array of object

No

Additional relations linked to the building. Empty or omitted when no extra relations are set.

extraRelations.extraRelationTypeName

string

No

Relation type assigned to this object for the linked party, for example cleaner or maintenance. Configurable in the Bloxs admin module.

extraRelations.relationReference

string

No

Reference of the linked relation. Must correspond to an existing relation registered in Bloxs.

remarks

string

No

Free text remarks stored on the building.

underManagementSince

string (date-time)

No

Date the building came under management. ISO 8601 format, for example 2026-01-01T00:00:00.

salesDate

string (date-time)

No

Date the building was sold, if applicable. ISO 8601 format.

lastModified

string (date-time)

Yes

Date and time the building was last modified. ISO 8601 format, UTC.

address.street

string

Yes

Street name of the building's address. Maximum length 200 characters.

address.houseNumber

string

No

House number of the building's address, including any suffix, for example \"12A\". Maximum length 40 characters.

address.postalCode

string

Yes

Postal code of the building's address. Maximum length 20 characters.

address.city

string

Yes

City of the building's address. Maximum length 200 characters.

address.countryISOCode

string

Yes

ISO 3166-1 alpha-2 country code of the building's address, for example \"NL\". Maximum length 2 characters.

regionName

string

No

Region the building is assigned to.

rawFloorArea

number (double)

No

Raw floor area of the building, in square meters, measured according to the NEN2580 standard. Decimals are separated with a period.

rentableFloorArea

number (double)

No

Rentable floor area of the building, in square meters, measured according to the NEN2580 standard. Decimals are separated with a period.

usableFloorArea

number (double)

No

Usable floor area of the building, in square meters.

energyIndex

number (double)

No

Energy index of the building.

estateAgentReference

string

No

Reference of the estate agent associated with the building.

technicalManagement

boolean

Yes

Indicates whether the building is under technical management.

financialManagement

boolean

Yes

Indicates whether the building is under financial management.

mandateAmount

number (double)

No

Mandate amount related to technical management. It indicates the limit up to which the manager may approve repairs and maintenance costs before requiring the owner's approval.

constructionYear

integer

No

Year the building was constructed.

isDivisible

boolean

Yes

Indicates whether the building can be divided into rentable units. Derived from the assigned category.

divisibleInfo.divisibleType

integer

Yes

Divisibility type of the building. Valid values are 1 (SingleUnit), 2 (DivisibleByUnits), or 3 (DivisibleByFloorArea).

divisibleInfo.divisibleFloorAreaType

integer

No

Floor area type used when divisibleType is DivisibleByFloorArea. Valid values are 0 (NA), 1 (RawFloorArea), 2 (RentableFloorArea), or 3 (UsableFloorArea).

divisibleInfo.divisibleValue

number (double)

No

Threshold value used together with divisibleFloorAreaType to determine divisibility.

" } } }, "components": { "schemas": { "BuildingAPIDetailModel": { "type": "object", "properties": { "reference": { "type": "string", "nullable": true }, "externalIdentifier": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "ownerReference": { "type": "string", "nullable": true }, "categoryName": { "type": "string", "nullable": true }, "extraRelations": { "type": "array", "items": { "$ref": "#/components/schemas/RealEstateExtraRelationAPIModel" }, "nullable": true }, "remarks": { "type": "string", "nullable": true }, "underManagementSince": { "type": "string", "format": "date-time", "nullable": true }, "salesDate": { "type": "string", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "format": "date-time" }, "address": { "$ref": "#/components/schemas/Address" }, "regionName": { "type": "string", "nullable": true }, "rawFloorArea": { "type": "number", "format": "double", "nullable": true }, "rentableFloorArea": { "type": "number", "format": "double", "nullable": true }, "usableFloorArea": { "type": "number", "format": "double", "nullable": true }, "energyIndex": { "type": "number", "format": "double", "nullable": true }, "estateAgentReference": { "type": "string", "nullable": true }, "technicalManagement": { "type": "boolean" }, "financialManagement": { "type": "boolean" }, "mandateAmount": { "type": "number", "format": "double", "nullable": true }, "constructionYear": { "type": "integer", "format": "int32", "nullable": true }, "isDivisible": { "type": "boolean" }, "divisibleInfo": { "$ref": "#/components/schemas/DivisibleInfo" } }, "additionalProperties": false }, "RealEstateExtraRelationAPIModel": { "type": "object", "properties": { "extraRelationTypeName": { "type": "string", "nullable": true }, "relationReference": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Address": { "required": [ "city", "countryISOCode", "postalCode", "street" ], "type": "object", "properties": { "street": { "maxLength": 200, "minLength": 0, "type": "string" }, "houseNumber": { "maxLength": 40, "minLength": 0, "type": "string", "nullable": true }, "postalCode": { "maxLength": 20, "minLength": 0, "type": "string" }, "city": { "maxLength": 200, "minLength": 0, "type": "string" }, "countryISOCode": { "maxLength": 2, "minLength": 0, "type": "string" } }, "additionalProperties": false }, "DivisibleInfo": { "required": [ "divisibleType" ], "type": "object", "properties": { "divisibleType": { "type": "integer", "description": "SingleUnit = 1\nDivisibleByUnits = 2\nDivisibleByFloorArea = 3", "format": "int32", "x-enumNames": [ "SingleUnit", "DivisibleByUnits", "DivisibleByFloorArea" ] }, "divisibleFloorAreaType": { "type": "integer", "description": "NA = 0\nRawFloorArea = 1\nRentableFloorArea = 2\nUsableFloorArea = 3", "format": "int32", "nullable": true, "x-enumNames": [ "NA", "RawFloorArea", "RentableFloorArea", "UsableFloorArea" ] }, "divisibleValue": { "maximum": 2147483647, "minimum": 0, "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false } } } } ````