Experience the difference of "Elite".

Getting Started

Core Concepts

Overview

Bookings & Quotes

Damage Protection

Data Management

Deposits

Email Template Library

Fields

Guests

Integrations

Listing Site Integration

Messaging

My Account

Payment Processing

Privacy & Security

Properties

Property Management

Quotes

Rates

Renter Agreements

Reporting

Reviews

Rules

Security Deposits

Suppressed Email Addresses

Tags

Taxes

Team Access

Technical Stuff

Travel Insurance

Triggers

Verified Email Domains

Channel Management

Channel Management

API Integrations

Calendar Import/Export

Channel Bridge

Integrations

OwnerRez APIs

Payment Processing

Testing

Websites

Change Log

2024

2023

2022

2021

2020

2019

Staff Reference

API for Channel Integration - Example - Review Index

Reviews are different from other HAXML endpoints in that they require a POST request to fetch data instead of a GET.

The reviews index provides a list of all published reviews for single listing for a single advertiser. The payload on this request must include both advertiserId and listingExternalId.

This request may optionally be filtered by startDate and endDate to limit the results. Format dates as YYYY-MM-DD.

Example request for all reviews:

cURL:

curl --user ${ownerrez_user}:${ownerrez_key} --location --request POST "${ownerrez_api}/haapi/haxml/${ownerrez_account_id}/reviewindex" --header 'Content-Type: application/xml' --data-raw "

<?xml version=\"1.0\"?>
<reviewContentIndexRequest>
<advertiserId>${ownerrez_account_id}</advertiserId>
<listingExternalId>${ownerrez_property_id}</listingExternalId>
</reviewContentIndexRequest>" --silent | xmllint --format -

Response:

?xml version="1.0"?>
<reviewContentIndex>
<documentVersion>1.1</documentVersion>
<advertiser>
<advertiserId>ora7ccdcde40x</advertiserId>
<reviewContentIndexEntry>
<externalId>ORREV108300211</externalId>
<lastUpdatedDate>2022-09-19T19:19:28</lastUpdatedDate>
<listingExternalId>orp5b2e1ax</listingExternalId>
<reviewUrl>https://faststage.ownerrez.com/haapi/haxml/ora7ccdcde40x/review/ORREV108300211</reviewUrl>
<unitExternalId>orp5b2e1ax</unitExternalId>
</reviewContentIndexEntry>
</advertiser>
</reviewContentIndex>

Example request with startDate filter:

cURL:

curl --user ${ownerrez_user}:${ownerrez_key} --location --request POST "${ownerrez_api}/haapi/haxml/${ownerrez_account_id}/reviewindex" --header 'Content-Type: application/xml' --data-raw "
<?xml version=\"1.0\"?>
<reviewContentIndexRequest>
<advertiserId>${ownerrez_account_id}</advertiserId>
<listingExternalId>${ownerrez_property_id}</listingExternalId>
<startDate>2020-01-01</startDate>
</reviewContentIndexRequest>" --silent | xmllint --format -

Response:

<reviewContentIndex>
<documentVersion>1.1</documentVersion>
<advertiser>
<advertiserId>ora7ccdcde40x</advertiserId>
</advertiser>
</reviewContentIndex>