Get published objects filtered and paged

paging.pageSize

integer

No

Maximum number of objects 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.reference

string

No

Filters results on the internal identifier of the object.

filter.externalIdentifier

string

No

Filters results on the external identifier of the object.

filter.name

string

No

Filters results on the custom display name of the object.

filter.addressStreetAndHouseNumber

string

No

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

filter.addressPostalCode

string

No

Filters results on the postal code of the published object's address.

filter.addressCity

string

No

Filters results on the city of the published object's address.

filter.addressCountryCode

string

No

Filters results on the country code of the published object's address.

filter.publishedStatus

integer

No

Filters results on publication status. Valid values are 0 (Available), 1 (Reserved), 2 (Rented), or 3 (UnderOption).

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.

filter.lastModified_Publication.from

string (date-time)

No

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

filter.lastModified_Publication.to

string (date-time)

No

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

filter.publishedDate.from

string (date-time)

No

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

filter.publishedDate.to

string (date-time)

No

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

filter.availableFrom.from

string (date-time)

No

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

filter.availableFrom.to

string (date-time)

No

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

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.

publications

array of object

No

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

publications.reference

string

No

Internal identifier of the published object.

publications.externalIdentifier

string

No

External identifier of the published object.

publications.name

string

No

Custom display name of the published object.

publications.addressStreetAndHouseNumber

string

No

Street and house number of the published object's address.

publications.addressPostalCode

string

No

Postal code of the published object's address.

publications.addressCity

string

No

City of the published object's address.

publications.addressCountryCode

string

No

Country code of the published object's address.

publications.publishedStatus

integer

Yes

Publication status of the object. Valid values are 0 (Available), 1 (Reserved), 2 (Rented), or 3 (UnderOption).

publications.lastModified

string (date-time)

Yes

Timestamp of the last modification to the object itself. ISO 8601 format, UTC.

publications.lastModified_Publication

string (date-time)

Yes

Timestamp of the last modification made to any of the custom published properties. ISO 8601 format, UTC.

publications.publishedDate

string (date)

Yes

Date the object was initially published.

publications.availableFrom

string (date)

No

Date from which the object is available.