API - Planyo Web Services - list_reviews

You are here: Planyo » Help » API » list_reviews



Use this function to list the reviews added by clients.


resource_id int optional
ID of the resource. When specified, only reviews added for this resource will be returned. When not passed, the function returns reviews added for any resource of the site.
limit int optional
With this parameter you can limit the number of reviews returned. The function returns the max of 500 latest reviews.
method string required
must be set to list_reviews
language string optional
by specifying a 2-letter (ISO 639-1) language code (all capital letters e.g. EN, DE, FR, ES, IT) you can change the language of the text values returned
api_key string required
your API key - Click here to get your key. If your API key uses a hash key, you must also include the parameters hash_key and hash_timestamp.


results array
List of named arrays containing review data. The keys are as follows:
rating - the value entered by the client (from 1 to 5)
date - DateTime when the review was added, e.g. 2018-06-21 18:07:00
text - the comment as added by the client
reply - the text of the admin reply if any
user_id - the ID of the user related to the review / reservation
first_name - the first name of the user
resource_id - the ID of the resource related to the reservation being reviewed

API playground:

Click here to test this function in the API playground.