OWownerrez
Listings

Query for a pageable list of property listings.

Changed on

Amenities-only listing access returns the base listing and amenities. Rooms, bathrooms, images, and descriptions need the WordPress Plugin + Integrated Websites premium, full listing access, or a self-use OAuth app; otherwise those collections are omitted.

Behind a premium feature. Using your own account? Create an OAuth app and click Grant Access To Me — no premium needed. Otherwise the account needs the WordPress Plugin + Integrated Websites premium, or your OAuth app needs listing access (a partnership agreement — email partnerhelp@ownerrez.com with the subject Listing Endpoints Access). Without one of those, every call returns 402 external_sites_not_enabled.

get/v2/listings

Request

  • Base URL
    https://api.ownerrez.com
  • URL
    https://api.ownerrez.com/v2/listings
  • Auth
    • HTTP bearer
    • or HTTP basic

Query parameters

includeAmenitiesboolean

Include amenities collections on results.

includeRoomsboolean

Include rooms collection on results. Omitted for amenities-only listing access.

includeBathroomsboolean

Include bathrooms collection on results. Omitted for amenities-only listing access.

includeImagesboolean

Include images collection on results. Omitted for amenities-only listing access.

includeDescriptions'html' | 'text'

Include descriptions on results. The specified format (HTML or Text) is applied to Short Description and Long Description. Omitted for amenities-only listing access.

limitinteger

Maximum records to return. Default 20, maximum 100.

offsetinteger

Records to skip from the start of the collection. Default 0.

Response

limitinteger

The maximum number of records per page.

next_page_urlstring

URL to fetch the next page of records. A null value indicates that there are no more pages in the collection.

offsetinteger

The current offset from the start of the collection.

Changes

  • 838877899156Revision changes
    • warning

      added the new deck enum value to the //// response property for the response status

    • warning

      added the new garden enum value to the //// response property for the response status

    • warning

      added the new onsen enum value to the //// response property for the response status

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter offset

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 0a32dcf88e6aRevision changes
    • warning

      added the new landmark_view enum value to the /// response property for the response status