Get a paged list of existing buildings, optionally filtered to the given parameters. A param-based alternative to the '/filter' POST endpoint.
Get buildings filtered and paged
This endpoint returns a paged list of existing buildings, optionally filtered by the given query parameters.
Integrators use it to display or synchronize multiple buildings at once, for example when populating a list view in an external application, rather than retrieving buildings one at a time.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
pageSize | integer | No | Maximum number of buildings 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 building. |
reference | string | No | Filters results on the internal identifier of the building. |
externalIdentifier | string | No | Filters results on the external identifier of the building. |
ownerReference | string | No | Filters results on the reference of the owner the building belongs to. |
estateAgentReference | string | No | Filters results on the reference of the estate agent of the building. |
addressStreetAndHouseNumber | string | No | Filters results on the street and house number of the building's address. |
addressPostalCode | string | No | Filters results on the postal code of the building's address. |
addressCity | string | No | Filters results on the city of the building's address. |
addressCountryISOCode | string | No | Filters results on the country ISO code of the building's address. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
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. |
buildings | array of object | No | The list of buildings matching the filter, for the requested page. Empty or omitted when no buildings match. |
buildings.name | string | No | Name of the building. |
buildings.reference | string | No | Internal identifier of the building. |
buildings.externalIdentifier | string | No | External identifier of the building, as set by the integrating system. |
buildings.ownerReference | string | No | Reference of the owner the building belongs to. |
buildings.estateAgentReference | string | No | Reference of the estate agent associated with the building. |
buildings.addressStreetAndHouseNumber | string | No | Street and house number of the building's address. |
buildings.addressPostalCode | string | No | Postal code of the building's address. |
buildings.addressCity | string | No | City of the building's address. |
buildings.addressCountryISOCode | string | No | Country ISO code of the building's address. |
buildings.rawFloorArea | number (double) | No | Raw floor area of the building, in square meters, measured according to the NEN2580 standard. Decimals are separated with a period. |
buildings.rentableFloorArea | number (double) | No | Rentable floor area of the building, in square meters, measured according to the NEN2580 standard. Decimals are separated with a period. |
buildings.usableFloorArea | number (double) | No | Usable floor area of the building, in square meters. |
buildings.underManagementSince | string (date-time) | No | Date the building came under management. ISO 8601 format. |
buildings.salesDate | string (date-time) | No | Date the building was sold, if applicable. ISO 8601 format. |
buildings.lastModified | string (date-time) | Yes | Date and time the building was last modified. ISO 8601 format, UTC. |
The requested page size. Defaults to 100 when not given.
The requested page number. Defaults to 1 when not given.
Optional filter on the name of the building.
Optional filter on the reference of the building.
Optional filter on the external API identifier of the building.
Optional filter on the reference of the owner the building belongs to.
Optional filter on the reference of the estate agent of the building.
Optional filter on the street and house number of the address of the building.
Optional filter on the postal code of the address of the building.
Optional filter on the city of the address of the building.
Optional filter on the country ISO code of the address of the building.
OK
Ascending = 0 Descending = 1