Overview

The Retrieve Reviews endpoint allows the Agent to retrieve reviews available in the system or access a specific review by its unique identifier. This API provides valuable insights and feedback from guests who have stayed at various properties managed within the system.

Available Endpoints

Method	Endpoint	Description
GET	v2024.07.31/reviews	Retrieve all reviews available in the system.
GET	v2024.07.31/reviews/{review_id}	Retrieve a specific review by its unique identifier.

Path Parameters

Path Parameter	Required / Optional	Description
{review_id}	Required	Unique identifier for a review.

Query String Parameters

Parameter	Required / Optional	Description	Data Type
page	Optional	The page to be shown (defaults to 1).	int
page_size	Optional	Limits the number of returned results (defaults to 25).	int
no_total	Optional	Removes the total page count for faster results (defaults to false).	boolean
last_update_date	Optional	Only return objects that have been modified after a certain date	date-time
unit_id	Optional	The unique identifier for a specific unit in the inventory.	int
unit_ids	Optional	The unique identifiers for multiple units in the inventory.	array[ints]
management_company_user_id	Optional	The unique identifier for a specific supplier of units.	int
management_company_user_ids	Optional	The unique identifiers for multiple suppliers of units.	array[ints]
review_id	Optional	The unique identifier for a specific review.	int
review_ids	Optional	The unique identifiers for multiple reviews.	array
reservation_id	Optional	The unique identifier for a specific reservation.	int
reservation_ids	Optional	The unique identifiers for multiple reservations.	array[ints]
review_start	Optional	Only return reviews that were made after a certain date	date-time
review_end	Optional	Only return reviews that were made before a certain date.	date-time
arrival_start	Optional	Only return reviews that have a reservation that arrives after a certain date.	date-time
arrival_end	Optional	Only return reviews that have a reservation that arrives before a certain date.	date-time
departure_start	Optional	Only return reviews that have a reservation that departs after a certain date.	date-time
departure_end	Optional	Only return reviews that have a reservation that departs before a certain date.	date-time

Response Definitions

Response Item	Description	Data Type
`"reviews"`	An array containing review details.	array[objects]

`"reviews"` Object

Response Item	Description	Data Type
`"id"`	The unique identifier of the review.	int
`"management_company_user_id"`	The unique identifier for the supplier who owns the review.	int
`"review_date"`	The date when the review was submitted.	date
`"rating"`	The numerical rating given by the guest for the property or experience.	float
`"rating_scale"`	The maximum rating scale available for the review.	float
`"anonymous"`	A flag indicating whether the review is submitted anonymously (`true`) or not (`false`).	boolean
`"name"`	The name of the reviewer (if provided).	string
`"emails"`	The email address(s) of the reviewer (if provided).	string
`"published"`	A flag indicating whether the review has been published (`true`) or not (`false`).	boolean
`"content"`	The content of the review as an array of objects, where each object has a `"value"` field containing the review text.	array[object]
`"reviewer"`	The type of reviewer, such as `"GUEST"` for a guest review.	string
`"status"`	The status of the review (e.g., `"approved"` or `"pending"`).	string
`"unit_id"`	The unique identifier of the unit in the inventory to which the review belongs.	int
`"ready_only"`	A value indicating whether the review is read-only (immutable) (`true`) or editable (`false`).	boolean

`"content"` Object

Response Item	Description	Data Type
`"value"`	A field containing the review text.	string

Sample Request

curl --location 'https://api.ciiruspartners.com/v2024.07.31/reviews?page=2&page_size=25&no_total=false' \
--header 'Authorization: Basic {APIUsername:APIPassword}'

Sample Response

{
    "reviews": [
        {
            "id": 30768,
            "management_company_user_id": 0,
            "review_date": "2019-08-29",
            "rating": 5.0,
            "rating_scale": 5.0,
            "anonymous": false,
            "name": "Guest Name",
            "emails": "[email protected]",
            "published": false,
            "content": [
                {
                    "value": "Test Review"
                }
            ],
            "reviewer": "GUEST",
            "status": "not_approved",
            "unit_id": 226596,
            "read_only": true
        },
        {
            "id": 58219,
            "management_company_user_id": 0,
            "review_date": "2021-10-06",
            "rating": 4.0,
            "rating_scale": 4.0,
            "anonymous": false,
            "name": "Sample Test",
            "emails": "[email protected]",
            "published": true,
            "content": [
                {
                    "value": "Wonderful property and great customer service provided by host.  Location was superb."
                }
            ],
            "reviewer": "GUEST",
            "status": "approved",
            "unit_id": 265308,
            "read_only": true
        },
        {
            "id": 3,
            "management_company_user_id": 0,
            "review_date": "2011-12-29",
            "rating": 4.0,
            "rating_scale": 4.0,
            "anonymous": false,
            "name": "John Johnson",
            "emails": "",
            "published": true,
            "content": [
                {
                    "value": "Lovely place.\r\nWe all realy enjoyed the facilities and the fact it was so close to all the theme parks.\r\nThe management company were really helpful and met all our expectations."
                }
            ],
            "reviewer": "GUEST",
            "status": "approved",
            "unit_id": 41123,
            "read_only": true
        },..
    ],
    "paging": {
        "next_page_url": "https://api.ciiruspartners.com/vv2024.07.31/reviews?page=2&page_size=25&no_total=false",
        "total_page_count": 3,
        "page": 1,
        "page_size": 25
    }
}