Get sections filtered and paged

pageSize

integer

No

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

pageNumber

integer

No

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

name

string

No

Filters results on the name of the section.

reference

string

No

Filters results on the internal identifier of the section.

externalIdentifier

string

No

Filters results on the external identifier of the section.

complexReference

string

No

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

ownerReference

string

No

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

estateAgentReference

string

No

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

addressStreetAndHouseNumber

string

No

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

addressPostalCode

string

No

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

addressCity

string

No

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

addressCountryISOCode

string

No

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

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.

sections

array of object

No

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

sections.name

string

No

Name of the section.

sections.reference

string

No

Internal identifier of the section.

sections.externalIdentifier

string

No

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

sections.complexReference

string

No

Reference of the complex the section belongs to.

sections.addressStreetAndHouseNumber

string

No

Street and house number of the section's address.

sections.addressPostalCode

string

No

Postal code of the section's address.

sections.addressCity

string

No

City of the section's address.

sections.addressCountryISOCode

string

No

Country ISO code of the section's address.

sections.rawFloorArea

number (double)

No

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

sections.rentableFloorArea

number (double)

No

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

sections.usableFloorArea

number (double)

No

Usable floor area of the section, in square meters.

sections.underManagementSince

string (date-time)

No

Date the section came under management. ISO 8601 format.

sections.salesDate

string (date-time)

No

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

sections.lastModified

string (date-time)

Yes

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