Read Guest feedback entry

GET

/v1/object-types/hospitality.guest_feedback_entry/objects/{id}

const url = 'https://api.aerandil.com/v1/object-types/hospitality.guest_feedback_entry/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Read an existing instance.

One follow-up on a piece of guest feedback, written for an internal audience (the house to itself: internal_text, read on the floor) or the guest (guest_text, marked as the guest’s) — hubOS’s thread, which keeps the internal and the guest follow-up as separate texts. A guest entry is sent into the guest’s open conversation at the house as a reply (guest_feedback_entry_sent_as names the message); when there is none, or the guest has said not to be written to, the entry is the record and undelivered_reason says why it was not sent. An entry may hand the case to a role (delegated_to_role). Written once; the author is the staff member linked by guest_feedback_entry_by_staff, or the principal on the entry’s event.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.guest_feedback_entry:read

Parameters

Path Parameters

required

string format: uuid

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

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

200

Object found.

application/json

object

created_at

required

string format: date-time

required

string format: uuid

object_type

required

Allowed value: hospitality.guest_feedback_entry

properties

required

object

audience

required

Internal (the house to itself) or guest (what the guest was told)

string

Allowed values: internal guest

delegated_to_role

The role this entry handed the case to

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

guest_text

What the guest was told — set on a guest entry only

string

required

Guest feedback entry id

string

internal_text

The internal follow-up — set on an internal entry only

string

recorded_at

required

When the follow-up was written

string format: date-time

undelivered_reason

Why a guest entry was not sent to the guest

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_entry",
  "properties": {
    "audience": "internal",
    "delegated_to_role": "front_office_agent"
  },
  "scope": {
    "level": "tenant"
  }
}

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

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