Get complexes filtered and paged

paging.pageSize

integer

No

Maximum number of complexes 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 complex.

filter.reference

string

No

Filters results on the internal identifier of the complex.

filter.externalIdentifier

string

No

Filters results on the external identifier of the complex.

filter.ownerReference

string

No

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

filter.estateAgentReference

string

No

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

filter.addressStreetAndHouseNumber

string

No

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

filter.addressPostalCode

string

No

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

filter.addressCity

string

No

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

filter.addressCountryISOCode

string

No

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

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.

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.