Skip to main content
Review tools are available through REST and MCP to API tokens, OAuth connections and the Operator. A workspace can also give them to its chat and voice agents. During a guest conversation, an agent only sees that guest’s ratings. Every method also requires Portals access for the workspace.

Ratings

Each rating comes from one portal survey. stage is during_stay for the check-in survey and after_checkout for the checkout survey. A rating has its stars, the guest’s comment and photos when they sent them, the stay dates, the listing, the booking channel, and whether the guest opened a review link or said they left a review. Every rating carries contact_id, reservation_id, session_id and template_id, so you can look up the guest, the reservation, the portal session and the template it came from. All filters are optional and combine. A page can be short or empty while has_more is true, so follow next_cursor until has_more is false. Test-mode ratings are included with test_mode: true. Guests who rate their stay 5 stars see the workspace’s own review links, such as Google. Read them with reviews.links in portal settings. To add a link, send a new label and an https:// url. To change one, send its link_id or its current label, plus only the fields to change. Renaming a link needs its link_id. Set enabled to false to hide a link. A workspace can have up to 10 links. The checkout survey is turned on or off per template with after_checkout.reviews.enabled on templates.