Get a unit

reference

string

Conditional

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

externalIdentifier

string

Conditional

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

reference

string

No

Internal identifier of the unit.

externalIdentifier

string

No

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

name

string

No

Name of the unit. For room rentals, typically the address combined with a room number. Can appear on invoices and bills.

displayName

string

No

Display name of the unit, as shown in Bloxs.

ownerReference

string

No

Reference of the owner the unit belongs to.

categoryName

string

No

Category assigned to the unit. Category values are configurable in the Bloxs admin module and determine the divisibility rules of the unit.

extraRelations

array of object

No

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

underManagementSince

string (date-time)

No

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

salesDate

string (date-time)

No

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

lastModified

string (date-time)

Yes

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

complexReference

string

No

Reference of the complex the unit belongs to. A unit belongs to exactly one complex.

sectionReference

string

No

Reference of the section the unit belongs to, if applicable. A unit can belong to at most one section within its complex.

address.street

string

Yes

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

address.houseNumber

string

No

House number of the unit'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 unit's address. Maximum length 20 characters.

address.city

string

Yes

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

address.countryISOCode

string

Yes

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

rawFloorArea

number (double)

No

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

rentableFloorArea

number (double)

No

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

usableFloorArea

number (double)

No

Usable floor area of the unit, in square meters.

energyIndex

number (double)

No

Energy index of the unit.

isDivisible

boolean

Yes

Indicates whether the unit can be divided further. Derived from the assigned category.

divisibleInfo.divisibleType

integer

Yes

Divisibility type of the unit. 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.