Retrieve Reviews

Retrieve all reviews available in the system or retrieve a specific review by its unique identifier

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	v2023.07.31/reviews	Retrieve all Reviews available in the system
GET	v2023.07.31/reviews/{reviewId}	Retrieve a specific Review by its unique identifier

Path Parameters

Path Parameter	Required / Optional	Description
{reviewId}	Required	Unique Identifier for Review

Query String Parameters

Parameter	Required / Optional	Description	Data Type
page	Optional	The page to be shown	int
pageSize	Optional	Limits the number of returned results	int
lastUpdateDate	Optional	Only return objects which have been modified after a certain date	date-time
mcUserId	Optional	Unique Identifier for Supplier	int
mcUserIds	Optional	Unique Identifiers for Suppliers	array
unitId	Optional	Unique Identifier for Unit in Inventory	int
unitIds	Optional	Unique Identifier for Units in Inventory	array
reviewStart	Optional	Only return reviews which were made after a certain date	date-time
reviewEnd	Optional	Only return reservations which were made before a certain date	date-time
arrivalStart	Optional	Only return reservations which arrive after a certain date	date-time
arrivalEnd	Optional	Only return reservations which arrive before a certain date	date-time
departureStart	Optional	Only return reservations which depart after a certain date	date-time
departureEnd	Optional	Only return reservations which depart before a certain date	date-time
reviewId	Optional	Unique Identifier for Review	int
reviewIds	Optional	Unique Identifier for Reviews	array
reservationId	Optional	Unique Identifier for Reservation	int
reservationIds	Optional	Unique Identifier for Reservations	array

Response Definitions

Response Item	Description	Data Type
`"Reviews"`	An array containing Review details	array

`"Reviews"` Object

Response Item	Description	Data Type
`"id"`	The unique identifier of 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
`"email"`	The email address 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
`"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) or editable	boolean

`"content"` Object

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

Sample Request

curl --request GET \
     --url 'https://api.ciiruspartners.com/v2023.07.31/reviews?page=1&pageSize=50'

Sample Response

{
    "Reviews": [
        {
            "id": 13145,
            "review_date": "2017-03-14",
            "rating": 5.0,
            "rating_scale": 5.0,
            "anonymous": false,
            "name": "Test Review",
            "email": "[email protected]",
            "published": true,
            "content": [
                {
                    "value": "Best Home ever!"
                }
            ],
            "reviewer": "GUEST",
            "status": "APPROVED",
            "unit_id": 219266,
            "read_only": true
        },
      ...
    ],
    "next_page_url": "https://api.ciiruspartners.com/v20230731/reviews?page=2&pageSize=50",
    "total_page_count": 4
}

Updated 3 months ago