Skip to main content

Host reviews

Parameters​

GroupSubgroupNameTypeRead/WriteDescription
idUUIDReadHost Review's id.
commentTextReadHost Review's comment.
shareableBooleanReadWhether Host Review is permitted for public use.
is_guest_recommendedBooleanReadWhether the host recommends guest.
source_idBooleanReadSource of the Host Review, always equal to the source of the booking.
criteriaObjectReadGuest ratings in specific criteria.
cleanlinessObjectReadDetails of given criterion.
ratingDecimalReadRating of guests' clealiness
commentTextReadComment on guests' clealiness
communicationObjectReadDetails of given criterion.
ratingDecimalReadRating of guests' communication
commentTextReadComment on guests' communication
respect_house_rulesObjectReadDetails of given criterion.
ratingDecimalReadRating of guests' respect of house rules
commentTextReadComment on guests' respect of house rules
created_atTimeReadReview's create time.
updated_atTimeReadReview's update time.
submitted_atTimeReadHost Review's submission time. Once filled, no futher updates are required for given object.
expires_atTimeReadHost Review's expiry time. Once that time is passed, submission will no longer be possible.

List host reviews​

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

GET /host_reviews
response.json
{
  "links": {
    "host_reviews.source": "https://www.bookingsync.com/api/v3/sources/{host_reviews.source}",
    "host_reviews.booking": "https://www.bookingsync.com/api/v3/bookings/{host_reviews.booking}",
    "host_reviews.rental": "https://www.bookingsync.com/api/v3/rentals/{host_reviews.rental}",
    "host_reviews.account": "https://www.bookingsync.com/api/v3/accounts/{host_reviews.account}",
    "host_reviews.reply": "https://www.bookingsync.com/api/v3/review_replies/{host_reviews.reply}"
  },
  "host_reviews": [
    {
      "links": {
        "account": 1,
        "booking": 96,
        "rental": 1,
        "reply": null,
        "source": 1
      },
      "id": "04356dc9-1349-4e05-b818-09ccdac8d5dd",
      "comment": "Awesome\n        place",
      "shareable": true,
      "criteria": {
        "cleanliness": {
          "rating": "4.5",
          "comment": null
        },
        "communication": null,
        "respect_house_rules": {
          "rating": "5.0",
          "comment": "Everything great!"
        }
      },
      "submitted_at": null,
      "is_guest_recommended": true,
      "expires_at": "2025-04-18T14:00:27.182Z",
      "created_at": "2025-04-11T14:00:27.182Z",
      "updated_at": "2025-04-18T14:00:27.182Z"
    }
  ],
  "meta": {}
}

Get a single host review​

Returns a single host review identified by ID.

GET /host_reviews/:host_review_id
response.json
{
  "links": {
    "host_reviews.source": "https://www.bookingsync.com/api/v3/sources/{host_reviews.source}",
    "host_reviews.booking": "https://www.bookingsync.com/api/v3/bookings/{host_reviews.booking}",
    "host_reviews.rental": "https://www.bookingsync.com/api/v3/rentals/{host_reviews.rental}",
    "host_reviews.account": "https://www.bookingsync.com/api/v3/accounts/{host_reviews.account}",
    "host_reviews.reply": "https://www.bookingsync.com/api/v3/review_replies/{host_reviews.reply}"
  },
  "host_reviews": [
    {
      "links": {
        "account": 1,
        "booking": 96,
        "rental": 1,
        "reply": null,
        "source": 1
      },
      "id": "04356dc9-1349-4e05-b818-09ccdac8d5dd",
      "comment": "Awesome\n        place",
      "shareable": true,
      "criteria": {
        "cleanliness": {
          "rating": "4.5",
          "comment": null
        },
        "communication": null,
        "respect_house_rules": {
          "rating": "5.0",
          "comment": "Everything great!"
        }
      },
      "submitted_at": null,
      "is_guest_recommended": true,
      "expires_at": "2025-04-18T14:00:27.186Z",
      "created_at": "2025-04-11T14:00:27.186Z",
      "updated_at": "2025-04-18T14:00:27.186Z"
    }
  ],
  "meta": {}
}

Create a new host review​

Create submitted host review​

Creates a submitted host review for given booking. Such a host review will be no longer editable and requires all data to be filled (comment, shareable, is_guest_recommended, source_id, submitted_at, all criteria with at least rating).

POST /bookings/:booking_id/host_reviews

Create draft host review​

Creates a draft host review for given booking. Such a host review will be editable until submitted, it requires bare minimum for a successful creation (shareable, source_id)

POST /bookings/:booking_id/host_reviews/draft

Edit draft review​

Submit draft host review​

Submits host review making it final and no longer editable. Apart from shareable and source_id which can be set only during creation, all other attibutes (comment, is_guest_recommended, submitted_at, all criteria with at least rating) are required.

PUT /host_reviews/draft/:host_review_id/submit

Modify draft host review without submitting​

Updates host review attributes without submitting it, thus allowing for further editions. Apart from shareable and source_id which can be set only during creation, all other attibutes are optional.

PUT /host_reviews/draft/:host_review_id