> ## 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 complex > Get an existing complex. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the complex. ## OpenAPI ````json GET /api/v1/realestateobjects/complexes { "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/complexes": { "get": { "tags": [ "Complexes" ], "summary": "Get a complex", "description": "Get an existing complex. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the complex.", "operationId": "GetComplex", "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/ComplexAPIDetailModel" } } } }, "404": { "description": "The requested complex was not found." } }, "x-d360-narrative-url": "

Get a complex

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

Integrators call it to look up a collection of rentable units, typically under one roof though not always, before displaying, syncing, or updating its data in an external system.

The complex 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 complex. Either reference or externalIdentifier must be provided. If both are given, the complex must match both values.

externalIdentifier

string

Conditional

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

Response Fields

Field

Type

Required

Description

reference

string

No

Internal identifier of the complex.

externalIdentifier

string

No

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

name

string

No

Name of the complex.

displayName

string

No

Display name of the complex, as shown in Bloxs.

ownerReference

string

No

Reference of the owner the complex belongs to.

categoryName

string

No

Category assigned to the complex. 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 whether the complex must be divided into sections.

extraRelations

array of object

No

Additional relations linked to the complex. 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 complex.

underManagementSince

string (date-time)

No

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

salesDate

string (date-time)

No

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

lastModified

string (date-time)

Yes

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

address.street

string

Yes

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

address.houseNumber

string

No

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

address.postalCode

string

Yes

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

address.city

string

Yes

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

address.countryISOCode

string

Yes

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

estateAgentReference

string

No

Reference of the estate agent associated with the complex.

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 complex was constructed.

totalRawFloorArea

number (double)

No

Total raw floor area of all rentable units in the complex, in square meters, measured according to the NEN2580 standard. Decimals are separated with a period.

totalRentableFloorArea

number (double)

No

Total rentable floor area of all rentable units in the complex, in square meters, measured according to the NEN2580 standard. Decimals are separated with a period.

totalUsableFloorArea

number (double)

No

Total usable floor area of all rentable units in the complex, in square meters.

energyIndex

number (double)

No

Energy index of the complex.

technicalManagement

boolean

Yes

Indicates whether the complex is under technical management.

financialManagement

boolean

Yes

Indicates whether the complex is under financial management.

" } } }, "components": { "schemas": { "ComplexAPIDetailModel": { "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" }, "estateAgentReference": { "type": "string", "nullable": true }, "mandateAmount": { "type": "number", "format": "double", "nullable": true }, "constructionYear": { "type": "integer", "format": "int32", "nullable": true }, "totalRawFloorArea": { "type": "number", "format": "double", "nullable": true }, "totalRentableFloorArea": { "type": "number", "format": "double", "nullable": true }, "totalUsableFloorArea": { "type": "number", "format": "double", "nullable": true }, "energyIndex": { "type": "number", "format": "double", "nullable": true }, "technicalManagement": { "type": "boolean" }, "financialManagement": { "type": "boolean" } }, "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 } } } } ````