Get units filtered and paged

paging.pageSize

integer

No

Maximum number of units to return per page. Defaults to 100 when not given. Minimum 1, maximum 1000.

paging.pageNumber

integer

No

Page number to retrieve. Defaults to 1 when not given. Minimum 1, maximum 9999.

sorting.columnName

string

No

Field the results are sorted on, for example name.

sorting.order

integer

No

Sort direction for columnName. 0 sorts ascending, 1 sorts descending.

filter.name

string

No

Filters results on the name of the unit.

filter.reference

string

No

Filters results on the internal identifier of the unit.

filter.externalIdentifier

string

No

Filters results on the external identifier of the unit.

filter.complexReference

string

No

Filters results on the reference of the complex the unit belongs to.

filter.sectionReference

string

No

Filters results on the reference of the section the unit belongs to.

filter.ownerReference

string

No

Filters results on the reference of the owner of the unit.

filter.estateAgentReference

string

No

Filters results on the reference of the estate agent of the unit.

filter.addressStreetAndHouseNumber

string

No

Filters results on the street and house number of the unit's address.

filter.addressPostalCode

string

No

Filters results on the postal code of the unit's address.

filter.addressCity

string

No

Filters results on the city of the unit's address.

filter.addressCountryISOCode

string

No

Filters results on the country ISO code of the unit's address.

filter.rawFloorArea.from

number (double)

No

Minimum raw floor area to include in the selection, in square meters, measured according to the NEN2580 standard. Decimals are separated with a period.

filter.rawFloorArea.to

number (double)

No

Maximum raw floor area to include in the selection, in square meters, measured according to the NEN2580 standard. Decimals are separated with a period.

filter.rentableFloorArea.from

number (double)

No

Minimum rentable floor area to include in the selection, in square meters, measured according to the NEN2580 standard. Decimals are separated with a period.

filter.rentableFloorArea.to

number (double)

No

Maximum rentable floor area to include in the selection, in square meters, measured according to the NEN2580 standard. Decimals are separated with a period.

filter.usableFloorArea.from

number (double)

No

Minimum usable floor area to include in the selection, in square meters.

filter.usableFloorArea.to

number (double)

No

Maximum usable floor area to include in the selection, in square meters.

filter.underManagementSince.from

string (date-time)

No

Earliest underManagementSince date to include in the selection. ISO 8601 format.

filter.underManagementSince.to

string (date-time)

No

Latest underManagementSince date to include in the selection. ISO 8601 format.

filter.salesDate.from

string (date-time)

No

Earliest salesDate to include in the selection. ISO 8601 format.

filter.salesDate.to

string (date-time)

No

Latest salesDate to include in the selection. ISO 8601 format.

filter.lastModified.from

string (date-time)

No

Earliest lastModified timestamp to include in the selection. ISO 8601 format, UTC.

filter.lastModified.to

string (date-time)

No

Latest lastModified timestamp to include in the selection. ISO 8601 format, UTC.

paging.pageSize

integer

No

Page size used for this result set. Minimum 1, maximum 1000.

paging.pageNumber

integer

No

Page number returned in this result set. Minimum 1, maximum 9999.

sorting.columnName

string

No

Field the results are sorted on.

sorting.order

integer

No

Sort direction for columnName. 0 is ascending, 1 is descending.

units

array of object

No

The list of units matching the filter, for the requested page. Empty or omitted when no units match.

units.name

string

No

Name of the unit.

units.reference

string

No

Internal identifier of the unit.

units.externalIdentifier

string

No

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

units.complexReference

string

No

Reference of the complex the unit belongs to.

units.sectionReference

string

No

Reference of the section the unit belongs to, if applicable.

units.estateAgentReference

string

No

Reference of the estate agent associated with the unit.

units.addressStreetAndHouseNumber

string

No

Street and house number of the unit's address.

units.addressPostalCode

string

No

Postal code of the unit's address.

units.addressCity

string

No

City of the unit's address.

units.addressCountryISOCode

string

No

Country ISO code of the unit's address.

units.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.

units.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.

units.usableFloorArea

number (double)

No

Usable floor area of the unit, in square meters.

units.underManagementSince

string (date-time)

No

Date the unit came under management. ISO 8601 format.

units.salesDate

string (date-time)

No

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

units.lastModified

string (date-time)

Yes

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