Search Guest feedback

POST

/v1/object-types/hospitality.guest_feedback/search

const url = 'https://api.aerandil.com/v1/object-types/hospitality.guest_feedback/search';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"branch":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","cursor":"example","filters":[{"property":"id","type":"eq","value":"example"}],"limit":1,"order":"asc","property_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","scope":{"level":"tenant"},"sort_by":"created_at"}'
};

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

curl --request POST \
  --url https://api.aerandil.com/v1/object-types/hospitality.guest_feedback/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "cursor": "example", "filters": [ { "property": "id", "type": "eq", "value": "example" } ], "limit": 1, "order": "asc", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "scope": { "level": "tenant" }, "sort_by": "created_at" }'

Search for instances. Filters eq, contains, gte and lte AND-compose; or / not are additive follow-ups. Pages with an opaque cursor; the +1 fetch returns has_more without a second round-trip. Ordered by sort_by (default created_at) in order (default ascending), id breaking ties; rows with no value for a property key sort last.

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

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.guest_feedback:read

Request Body^required

application/json

object

branch

Optional open-branch id. Search composes that branch’s copy-on-first-write overlay instead of main, so a preview reads its own hypothetical writes. Omit to read main.

string format: uuid

cursor

Opaque cursor from a prior response’s next_cursor. Pass back verbatim; do not introspect.

string

filters

Conjunctive list of predicates. Empty or omitted matches every row in scope, capped by limit.

Array

One of:

object

property

required

Allowed value: id

type

required

Allowed value: eq

value

required

string

limit

Page size. Server defaults to 50, silently clamps at 500 (AIP-158 §3).

integer

>= 1 <= 500

order

Direction of sort_by: asc (oldest / smallest first) or desc. A cursor is bound to the sort_by and order it was minted under; another pair is refused (422).

string

default: asc

Allowed values: asc desc

property_id

The house a desk stands in: keeps this property’s rows (property- or venue-scoped there) and every row scoped to no property (tenant, brand, portfolio), and drops a sibling house’s — the meaning property_id has on the event tail.

string format: uuid

scope

One of: discriminator: level

object

level

required

string

Allowed value: tenant

Allowed values: tenant

sort_by

What the page is ordered by: the row’s created_at or updated_at, or a property whose type orders — strings, enums and dates as text, ints, decimals and durations as numbers, datetimes as instants. Rows with no value sort last in either direction. A property the caller is not cleared to read is refused (403).

string

default: created_at

Allowed values: created_at updated_at id kind category text received_at channel status delegated_to_role resolution resolved_at closed_at close_reason checkout_satisfaction checkout_satisfaction_at

Responses

200

Search results, ordered by (sort_by, id) in the requested order (ascending by default).

application/json

object

data

required

Array<object>

object

created_at

required

string format: date-time

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

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

has_more

required

boolean

next_cursor

Cursor for the next page; omitted when the result set is exhausted.

string

Example

{
  "data": [
    {
      "object_type": "hospitality.guest_feedback",
      "properties": {
        "category": "cleanliness",
        "channel": "in_person",
        "delegated_to_role": "front_office_agent",
        "kind": "complaint",
        "status": "open"
      },
      "scope": {
        "level": "tenant"
      }
    }
  ]
}

422

Validation error — unknown property or filter type mismatch.

Search Guest feedback

Authorizations

Request Bodyrequired

Responses

200

Example

422

Request Body^required