Skip to content
aerandil.com
GitHub

Read Guest feedback

GET
/v1/object-types/hospitality.guest_feedback/objects/{id}
curl --request GET \
  --url https://api.aerandil.com/v1/object-types/hospitality.guest_feedback/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

What a guest told the house — a complaint, a compliment or a suggestion (hubOS’s guest feedback form) — and where the house has got to with it: open when recorded, in_progress once someone follows up (an entry on its thread, a work order raised from it), resolved with what the house did, closed when the case is finished. A complaint names its category. The feedback holds no guest name or contact: the guest (guest_feedback_for_person), the stay it is about (guest_feedback_for_stay) and the message it came from (guest_feedback_from_message) are links, and the guest’s own words (text) are marked as the guest’s. The thread is its guest_feedback_entry rows; delegated_to_role is the role the case is with. It is filed under the house’s own labels (labels, guest_feedback_has_label) and, once the stay has departed, carries the guest’s checkout_satisfaction (1–5).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Object id (UUID v7, server-generated at create time).

Query Parameters

Section titled “Query Parameters”
branch
string format: uuid

Read through an open branch’s copy-on-first-write overlay view instead of the canonical (main) plane. Does not compose with as_of (422). The branch must exist under the caller’s tenant.

Responses

Section titled “Responses”

200

Section titled “200”

Object found.

Media typeapplication/json
object
created_at
required
string format: date-time
id
required
string format: uuid
object_type
required
Allowed value: hospitality.guest_feedback
properties
required
object
category
What it is about (cleanliness, noise, billing, service, food, maintenance, other); required on a complaint
string
Allowed values: cleanliness noise billing service food maintenance other
channel
How it reached the house: in person, by phone, a survey, a review, or the messaging channel of the message it came from
string
Allowed values: in_person phone survey review sms whatsapp email web_chat app_chat voice_ivr ota_inbox social_dm in_room_device other
checkout_satisfaction
How satisfied the guest said they were at checkout, 1 (not at all) to 5 (very) — a departed stay's
integer
checkout_satisfaction_at
When the checkout satisfaction was recorded
string format: date-time
close_reason
Why a complaint was closed without being resolved
string
closed_at
When the case was closed
string format: date-time
delegated_to_role
The role the case is with (hubOS's delegated profile)
string
Allowed values: front_office_agent front_office_supervisor concierge bell housekeeper housekeeping_supervisor engineer food_beverage_server food_beverage_manager chef spa_therapist spa_manager reservations_agent revenue_manager sales_manager manager_on_duty general_manager owner other runner
id
required
Guest feedback id
string
kind
required
Complaint, compliment or suggestion
string
Allowed values: complaint compliment suggestion
labels
The codes of the house's labels it is filed under — the same set as its guest_feedback_has_label edges
Array<string>
received_at
required
When the guest gave it
string format: date-time
resolution
What the house did about it
string
resolved_at
When it was resolved
string format: date-time
status
required
Open, in progress, resolved or closed
string
Allowed values: open in_progress resolved closed
text
What the guest said, in their words or the desk's summary of them
string
provenance

Per-property source attribution and pins. An entry under properties means the property’s current value came from that source (on the source’s own clock, source_updated_at); an entry under pins is a human override protecting the property from sourced writes.

object
pins
object
key
additional properties
object
pinned_at
string format: date-time
pinned_by
object
reason
required
string
properties
object
key
additional properties
object
external_id
string
recorded_at
required
string format: date-time
source
required
string
source_updated_at
string format: date-time
stream
string
scope
required
One of: discriminator: level
object
level
required
string
Allowed value: tenant
Allowed values: tenant
tenant_id
required
string format: uuid
updated_at
required
string format: date-time
version
required
integer
>= 1
Example
{
  "object_type": "hospitality.guest_feedback",
  "properties": {
    "category": "cleanliness",
    "channel": "in_person",
    "delegated_to_role": "front_office_agent",
    "kind": "complaint",
    "status": "open"
  },
  "scope": {
    "level": "tenant"
  }
}

Headers

Section titled “Headers”
ETag
string
/^"\d+"$/

Quoted strong validator (RFC 7232 §2.3) carrying the object’s monotonic version. Informational on the read path — object mutation goes through typed actions on /v1/actions/{action}/apply, not raw CRUD.

404

Section titled “404”

No object with that id (or soft-deleted).