OWownerrez
Listings

Fetch a listing.

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/{id}

Request

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

Path parameters

idinteger required

The Property ID of the listing to fetch.

Query parameters

descriptionFormat'html' | 'text'

The format to return for short and long descriptions. Omitted for amenities-only listing access.

Response

bathroom_countinteger

The number of bathrooms in this listing.

bathroom_full_countinteger

The number of "full" bathrooms in this listing.

bathroom_half_countinteger

The number of "half" bathrooms in this listing.

bedroom_countinteger

The number of bedrooms in this listing.

cancellation_policystring
check_in_instructionsstring

Check-in instructions for the listing. Can contain HTML.

directionsstring

Directions to the listing. Can contain HTML.

house_manualstring

House manual for the listing. Can contain HTML.

internet_infostring

Internet/Wifi details for the listing. Can contain HTML.

location_typesLocationTypeFeatures[]
nightly_rate_maxnumber nullable
nightly_rate_minnumber nullable
occupancy_maxinteger nullable

The maximum occupancy of this listing.

occupancy_mininteger

The minimum occupancy of this listing.

property_idinteger

The ID of the property to which this listing content pertains.

property_space_type'entire_home' | 'private_room' | 'shared_room'
registration_datestring date-time nullable
registration_numberstring
review_averagenumber
review_countinteger
sleeps_in_beds_countinteger nullable

The calculated maximum number of occupants this listing can fit into beds.

sleeps_maxinteger nullable
sleeps_mininteger nullable
wifi_networkstring

Wifi network name for internet access at the property.

wifi_passwordstring

Wifi network password for internet access at the property.

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 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

    • 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