Contents x
    Get published objects filtered and paged
    • 06 Jun 2025
    • 3 Minutes to read
    • Print
    • Dark
      Light
    Contents

    Get published objects filtered and paged

    • Updated on 06 Jun 2025
    • 3 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    Post
    /api/v1/realestateobjects/publish/filter

    Get a paged list of existing published objects, optionally filtered to the given parameters.

    An existing real estate object can be published. This means that specified data is accessible for a third party website for publishing. For example, unit x becomes available soon. Therefore the manager of the unit wants to publish the real estate object on a rental website. By publishing the unit, specified data becomes available for a third party website to retrieve through a pull/get.

    Retrieve a paged list of published objects, optionally filtered to the given parameters. 

    Either reference or externalIdentifier must have a value. Please note that if both identifiers are given, both must match; otherwise, an error message will be generated. It is recommended that the user utilizes only one identifier, with a preference for the reference.

    Use Case

    The user wants to display all the real estate objects which are published, to see if any data point needs to be adjusted.

    Request fields

    The request contains the following fields:

    FieldDescription
    paging.pageSize
    		The maximum number of pages to be returned per request. The default number is 100 and the maximum is 1.000. If more results are returned than specified in the PageSize, the remaining pages are dropped based on the reference (number).
    paging.pageNumber
    		This allows the requesting party to specify which of the pages they want to receive.
    sorting.columnNameThe data field based on which sorting will be applied. For example, if the user wants to sort the results based on ascending name, the value 'name' should be given here.
    sorting.orderBased on this value, the property defined in 'columnName' will either be sorted ascending (a-z) or descending (z-a).
    referenceThe reference of the real estate object from which the published data needs to be retrieved. This reference is generated by Bloxs.
    externalIdentifierThe unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system.
    nameA free description of the name of the real estate object. An example can be an office building. Even though the address is 'Office street 24', the official name of the office building is 'Empirium'. The property 'name' can be used to assign this custom name.
    addressStreetAndHouseNumber
    		The street and house number of the published object.
    addressPostalCode
    		The postal code of the published object.
    addressCity
    		The city in which the published object is located.
    addressCountryCode
    		The country code of the published object.
    publishedStatus
    		Enumeration regarding the status of the real estate object. For example 'available' or 'under option'.
    lastModified.from
    		Timestamp of the last modification within Bloxs (determined by Bloxs). This defines the lower limit of which objects should be returned.
    lastModified.to
    		Timestamp of the last modification within Bloxs (determined by Bloxs). This defines the upper limit of which objects should be returned.
    lastModified_Publication.from
    		Timestamp of the last modification done on one of the custom published properties. This defines the lower limit of which objects should be returned.
    lastModified_Publication.to
    		Timestamp of the last modification done on one of the custom published properties. This defines the upper limit of which objects should be returned.
    publishedDate.from
    		The date on which the real estate object was initially published. Later updates of the data do not influence this date. This defines the lower limit of which objects should be returned.
    publishedDate.to
    		The date on which the real estate object was initially published. Later updates of the data do not influence this date. This defines the upper limit of which objects should be returned.
    availableFrom.from
    		The date from which the property is available. This defines the lower limit of which objects should be returned.
    availableFrom.to
    		The date from which the property is available. This defines the upper limit of which objects should be returned.


    Security
    HTTP
    Type Bearer

    Please enter a valid token

    Body parameters
    Expand All
    object
    paging
    object (PagingInfo)
    pageSize
    integer (int32) | null
    Minimum1
    Maximum1000
    pageNumber
    integer (int32) | null
    Minimum1
    Maximum9999
    sorting
    object (SortingInfo)
    columnName
    string | null
    order
    integer (int32)
    Valid values[ 0, 1 ]
    filter
    object (PublishedObjectsSearchRequestFilter)
    reference
    string | null
    externalIdentifier
    string | null
    name
    string | null
    addressStreetAndHouseNumber
    string | null
    addressPostalCode
    string | null
    addressCity
    string | null
    addressCountryCode
    string | null
    publishedStatus
    integer (int32) | null
    Valid values[ 0, 1, 2, 3 ]
    lastModified
    object (CompareFilterModelDateTime)
    from
    string (date-time) | null
    to
    string (date-time) | null
    lastModified_Publication
    object (CompareFilterModelDateTime)
    from
    string (date-time) | null
    to
    string (date-time) | null
    publishedDate
    object (CompareFilterModelDateTime)
    from
    string (date-time) | null
    to
    string (date-time) | null
    availableFrom
    object (CompareFilterModelDateTime)
    from
    string (date-time) | null
    to
    string (date-time) | null
    Responses
    200

    OK

    Expand All
    object
    paging
    object (PagingInfo)
    pageSize
    integer (int32) | null
    Minimum1
    Maximum1000
    pageNumber
    integer (int32) | null
    Minimum1
    Maximum9999
    sorting
    object (SortingInfo)
    columnName
    string | null
    order
    integer (int32)
    Valid values[ 0, 1 ]
    publications
    Array of object (PublishedObjectsSearchResponseData) | null
    object
    reference
    string | null
    externalIdentifier
    string | null
    name
    string | null
    addressStreetAndHouseNumber
    string | null
    addressPostalCode
    string | null
    addressCity
    string | null
    addressCountryCode
    string | null
    publishedStatus
    integer (int32)
    Valid values[ 0, 1, 2, 3 ]
    lastModified
    string (date-time)
    lastModified_Publication
    string (date-time)
    publishedDate
    string (date)
    availableFrom
    string (date) | null
    What's Next