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