Skip to main content

Reviews

Overview​

This resource represents guests' (travelers') Reviews for the host for a given Booking.

info

Restrictions

  • A Booking can have multiple Reviews – but no more than one per source.
  • Each Review can have at most one Review Reply.

Parameters​

NameTypeRead/WriteDescription
accountIntegerReadAccount's ID related to the Review
rentalIntegerReadRental's ID related to the Review
sourceIntegerReadSource's ID related to the Review
replyUUIDReadReply's (ReviewReply)'s ID related to the Review
bookingIntegerReadBooking's ID related to the Review
idIntegerReadReview's ID.
titleTextReadTitle/Summary of the review.
commentTextReadComment from traveler (guest).
private_commentTextReadPrivate comment from the traveler (guest) (not meant to be exposed publicly).
ratingDecimalReadOverall rating of a stay
rating_accurateDecimalReadNon-rounded rating.
nameTextReadReviewer's name, cropped to show only the initial of the last name.
country_codeTextReadReviewer's country code.
shareableBooleanReadWhether Review is permitted for public use.
criteriaObjectReadHost ratings in specific criteria.
criteria.cleanlinessObjectReadDetails of given criterion.
criteria.cleanliness.ratingDecimalReadWas the cleanliness up to the standards?
criteria.cleanliness.commentTextReadAdditional feedback for a given criterion.
criteria.communicationObjectReadDetails of given criterion.
criteria.communication.ratingDecimalReadHow fast/easy the communication with the host was.
criteria.communication.commentTextReadAdditional feedback for a given criterion.
criteria.checkinObjectReadDetails of given criterion.
criteria.checkin.ratingDecimalReadHow smooth was the checkin process?
criteria.checkin.commentTextReadAdditional feedback for a given criterion.
criteria.locationObjectReadDetails of given criterion.
criteria.location.ratingDecimalReadWas the guest aware of any location dependent factors that could affect the stay (such as noise, safety, transportation etc.)?
criteria.location.commentTextReadAdditional feedback for a given criterion.
criteria.facilitiesObjectReadDetails of given criterion.
criteria.facilities.ratingDecimalReadWere facilities working and matching description?
criteria.facilities.commentTextReadAdditional feedback for a given criterion.
criteria.comfortObjectReadDetails of given criterion.
criteria.comfort.ratingDecimalReadWas the property warm enough, with enough lights. Were the beds and/or sofa comfy?
criteria.comfort.commentTextReadAdditional feedback for a given criterion.
criteria.staffObjectReadDetails of given criterion.
criteria.staff.ratingDecimalReadWas the staff friendly, attentive and respectful?
criteria.staff.commentTextReadAdditional feedback for a given criterion.
criteria.value_for_moneyObjectReadDetails of given criterion.
criteria.value_for_money.ratingDecimalReadWas it worth the price?
criteria.value_for_money.commentTextReadAdditional feedback for a given criterion.
criteria.accuracyObjectReadDetails of given criterion.
criteria.accuracy.ratingDecimalReadWas the property accurately represented on a website?
criteria.accuracy.commentTextReadAdditional feedback for a given criterion.
criteria.property_conditionObjectReadDetails of given criterion.
criteria.property_condition.ratingDecimalReadWhat was the condition of the property?
criteria.property_condition.commentTextReadAdditional feedback for a given criterion.
criteria.eco_friendlinessObjectReadDetails of given criterion.
criteria.eco_friendliness.ratingDecimalReadHow eco-friendly was the property?
criteria.eco_friendliness.commentTextReadAdditional feedback for a given criterion.
created_atTimeReadReview's create time.
updated_atTimeReadReview's update time.
submitted_atTimeReadReview's submission time. When not specified, defaults to creation time.
dismissed_byStringReadWhom the Review was dismissed by
dismissal_reasonStringReadThe Reason why the Review was dismissed
dismissed_atTimeReadWhen the Review was dismissed

List reviews​

List all guest reviews (from guest to host) for a given account(s).

GET /reviews

Response​

response.json
{
  "links": {
    "reviews.source": "https://www.bookingsync.com/api/v3/sources/{reviews.source}",
    "reviews.reply": "https://www.bookingsync.com/api/v3/review_replies/{reviews.reply}",
    "reviews.booking": "https://www.bookingsync.com/api/v3/bookings/{reviews.booking}",
    "reviews.rental": "https://www.bookingsync.com/api/v3/rentals/{reviews.rental}",
    "reviews.account": "https://www.bookingsync.com/api/v3/accounts/{reviews.account}"
  },
  "reviews": [
    {
      "links": {
        "account": 111,
        "booking": 222,
        "rental": 333,
        "reply": null,
        "source": 444
      },
      "id": 555,
      "rating": 5,
      "comment": "Amazing stay! The property was exactly as described and the host was very helpful.",
      "name": "John D.",
      "title": "Fantastic Experience",
      "country_code": "US",
      "created_at": "2023-12-01T10:00:00Z",
      "updated_at": "2023-12-01T10:00:00Z",
      "rating_accurate": "4.8",
      "shareable": true,
      "private_comment": "The WiFi was a bit slow but otherwise perfect",
      "submitted_at": "2023-12-01T10:00:00Z",
      "dismissed_at": null,
      "dismissed_by": null,
      "dismissal_reason": null,
      "criteria": {
        "cleanliness": {
          "rating": "4.5",
          "comment": "Very clean overall"
        },
        "checkin": {
          "rating": "5.0",
          "comment": "Smooth check-in process"
        },
        "communication": {
          "rating": "5.0",
          "comment": "Host responded quickly"
        },
        "location": {
          "rating": "4.0",
          "comment": "Great location, close to everything"
        },
        "facilities": {
          "rating": "4.5",
          "comment": "All amenities worked perfectly"
        },
        "comfort": {
          "rating": "5.0",
          "comment": "Very comfortable bed and furniture"
        },
        "staff": null,
        "value_for_money": {
          "rating": "4.0",
          "comment": "Good value for the price"
        },
        "accuracy": {
          "rating": "5.0",
          "comment": "Exactly as described in the listing"
        },
        "property_condition": {
          "rating": "4.5",
          "comment": "Property was well-maintained"
        },
        "eco_friendliness": {
          "rating": "4.0",
          "comment": "Good recycling options available"
        }
      }
    }
  ],
  "meta": {}
}

Get a single review​

Returns a single review identified by ID.

GET /reviews/:review_id

Response​

response.json
{
  "links": {
    "reviews.source": "https://www.bookingsync.com/api/v3/sources/{reviews.source}",
    "reviews.reply": "https://www.bookingsync.com/api/v3/review_replies/{reviews.reply}",
    "reviews.booking": "https://www.bookingsync.com/api/v3/bookings/{reviews.booking}",
    "reviews.rental": "https://www.bookingsync.com/api/v3/rentals/{reviews.rental}",
    "reviews.account": "https://www.bookingsync.com/api/v3/accounts/{reviews.account}"
  },
  "reviews": [
    {
      "links": {
        "account": 111,
        "booking": 222,
        "rental": 333,
        "reply": null,
        "source": 444
      },
      "id": 555,
      "rating": 5,
      "comment": "Amazing stay! The property was exactly as described and the host was very helpful.",
      "name": "John D.",
      "title": "Fantastic Experience",
      "country_code": "US",
      "created_at": "2023-12-01T10:00:00Z",
      "updated_at": "2023-12-01T10:00:00Z",
      "rating_accurate": "4.8",
      "shareable": true,
      "private_comment": "The WiFi was a bit slow but otherwise perfect",
      "submitted_at": "2023-12-01T10:00:00Z",
      "dismissed_at": null,
      "dismissed_by": null,
      "dismissal_reason": null,
      "criteria": {
        "cleanliness": {
          "rating": "4.5",
          "comment": "Very clean overall"
        },
        "checkin": {
          "rating": "5.0",
          "comment": "Smooth check-in process"
        },
        "communication": {
          "rating": "5.0",
          "comment": "Host responded quickly"
        },
        "location": {
          "rating": "4.0",
          "comment": "Great location, close to everything"
        },
        "facilities": {
          "rating": "4.5",
          "comment": "All amenities worked perfectly"
        },
        "comfort": {
          "rating": "5.0",
          "comment": "Very comfortable bed and furniture"
        },
        "staff": null,
        "value_for_money": {
          "rating": "4.0",
          "comment": "Good value for the price"
        },
        "accuracy": {
          "rating": "5.0",
          "comment": "Exactly as described in the listing"
        },
        "property_condition": {
          "rating": "4.5",
          "comment": "Property was well-maintained"
        },
        "eco_friendliness": {
          "rating": "4.0",
          "comment": "Good recycling options available"
        }
      }
    }
  ],
  "meta": {}
}

Create a new review​

Creates a review for given booking.

POST /bookings/:booking_id/reviews

Request​

request.json
{
  "reviews": [
    {
      "comment": "Amazing stay! The property was exactly as described and the host was very helpful.",
      "private_comment": "The WiFi was a bit slow but otherwise perfect",
      "title": "Fantastic Experience",
      "submitted_at": "2023-12-01T10:00:00Z",
      "rating": 4.8,
      "shareable": true,
      "source_id": 111,
      "criteria": {
        "cleanliness": {
          "rating": "4.5",
          "comment": "Very clean overall"
        },
        "communication": {
          "rating": "5.0",
          "comment": "Host responded quickly"
        },
        "checkin": {
          "rating": "5.0",
          "comment": "Smooth check-in process"
        },
        "value_for_money": {
          "rating": "4.0",
          "comment": "Good value for the price"
        },
        "accuracy": {
          "rating": "5.0",
          "comment": "Exactly as described in the listing"
        },
        "property_condition": {
          "rating": "4.5",
          "comment": "Property was well-maintained"
        }
      }
    }
  ]
}
response.json
{
  "links": {
    "reviews.source": "https://www.bookingsync.com/api/v3/sources/{reviews.source}",
    "reviews.reply": "https://www.bookingsync.com/api/v3/review_replies/{reviews.reply}",
    "reviews.booking": "https://www.bookingsync.com/api/v3/bookings/{reviews.booking}",
    "reviews.rental": "https://www.bookingsync.com/api/v3/rentals/{reviews.rental}",
    "reviews.account": "https://www.bookingsync.com/api/v3/accounts/{reviews.account}"
  },
  "reviews": [
    {
      "links": {
        "account": 111,
        "booking": 222,
        "rental": 333,
        "reply": null,
        "source": 444
      },
      "id": 555,
      "rating": 5,
      "comment": "Amazing stay! The property was exactly as described and the host was very helpful.",
      "name": "John D.",
      "title": "Fantastic Experience",
      "country_code": "US",
      "created_at": "2023-12-01T10:00:00Z",
      "updated_at": "2023-12-01T10:00:00Z",
      "rating_accurate": "4.8",
      "shareable": true,
      "private_comment": "The WiFi was a bit slow but otherwise perfect",
      "submitted_at": "2023-12-01T10:00:00Z",
      "dismissed_at": null,
      "dismissed_by": null,
      "dismissal_reason": null,
      "criteria": {
        "cleanliness": {
          "rating": "4.5",
          "comment": "Very clean overall"
        },
        "checkin": {
          "rating": "5.0",
          "comment": "Smooth check-in process"
        },
        "communication": {
          "rating": "5.0",
          "comment": "Host responded quickly"
        },
        "location": {
          "rating": "4.0",
          "comment": "Great location, close to everything"
        },
        "facilities": {
          "rating": "4.5",
          "comment": "All amenities worked perfectly"
        },
        "comfort": {
          "rating": "5.0",
          "comment": "Very comfortable bed and furniture"
        },
        "staff": null,
        "value_for_money": {
          "rating": "4.0",
          "comment": "Good value for the price"
        },
        "accuracy": {
          "rating": "5.0",
          "comment": "Exactly as described in the listing"
        },
        "property_condition": {
          "rating": "4.5",
          "comment": "Property was well-maintained"
        },
        "eco_friendliness": {
          "rating": "4.0",
          "comment": "Good recycling options available"
        }
      }
    }
  ],
  "meta": {}
}