Get an existing section. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the section.
Get a section
This endpoint retrieves the full detail record of an existing section.
A section is a subdivision within a complex, used to separate functional or physical parts of a property, for example a shop on the ground floor with apartments above.
Integrators call this endpoint to look up a section before displaying, syncing, or updating its data in an external system.
The section 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 section. Either reference or externalIdentifier must be provided. If both are given, the section must match both values. |
externalIdentifier | string | Conditional | External identifier of the section, as set by the integrating system. Either reference or externalIdentifier must be provided. If both are given, the section must match both values. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
reference | string | No | Internal identifier of the section. |
externalIdentifier | string | No | External identifier of the section, as set by the integrating system. |
name | string | No | Name of the section. |
displayName | string | No | Display name of the section, as shown in Bloxs. |
ownerReference | string | No | Reference of the owner the section belongs to. Inherited from the complex the section is part of. |
categoryName | string | No | Category assigned to the section. Category values are configurable in the Bloxs admin module. |
extraRelations | array of object | No | Additional relations linked to the section. 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 section. |
underManagementSince | string (date-time) | No | Date the section came under management. ISO 8601 format, for example 2026-01-01T00:00:00. |
salesDate | string (date-time) | No | Date the section was sold, if applicable. ISO 8601 format. |
lastModified | string (date-time) | Yes | Date and time the section was last modified. ISO 8601 format, UTC. |
address.street | string | Yes | Street name of the section's address. Maximum length 200 characters. |
address.houseNumber | string | No | House number of the section's address, including any suffix. Can also be used to enter a room number. Maximum length 40 characters. |
address.postalCode | string | Yes | Postal code of the section's address. Maximum length 20 characters. |
address.city | string | Yes | City of the section's address. Maximum length 200 characters. |
address.countryISOCode | string | Yes | ISO 3166-1 alpha-2 country code of the section's address, for example "NL". Maximum length 2 characters. |
complexReference | string | No | Reference of the complex the section belongs to. A section belongs to exactly one complex. |
totalRawFloorArea | number (double) | No | Total raw floor area of all units associated with the section, 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 units associated with the section, 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 units associated with the section, in square meters. |
The internal identifier of the model (i.e. Reference, Code, Name, depends on model).
The external API identifier of the model.
OK
The requested section was not found.