Read Recognition event

GET

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

const url = 'https://api.aerandil.com/v1/object-types/hospitality.recognition_event/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.recognition_event/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

A recorded recognition of a person — name acknowledged, preference anticipated, relationship remembered, gesture offered, upgrade provided, amenity provided, personal note left, birthday or anniversary marked, repeat visit acknowledged, VIP treatment initiated. Always-on across all loyalty archetypes — the program_type does not gate recognition; Aman runs recognition-only and Maybourne runs LHW + deep internal recognition independently. delivery_visibility types the Aman invisible-attention vs Ritz visible-attention axis: the same recognition can be delivered visibly (a hand-written welcome card on arrival) or invisibly (the temperature set to the guest’s preference before they enter the room). The pair with proposal 0002’s service_recovery_event lets the read-side projection surface the operator’s recognition-vs-recovery balance.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.recognition_event: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.recognition_event

properties

required

object

comp_amount

Recognition event comp amount

Comp amount when recognition includes value

object

amount

required

string format: decimal

currency

required

string format: iso-4217

comp_category

Comp category (toolkit dictionary key)

string

delivery_visibility

required

Delivery visibility

string

Allowed values: visible_to_guest invisible_to_guest

happened_at

required

When the recognition happened

string format: date-time

required

Recognition event id

string

recogniser

Recogniser principal identifier

string

recognition_action_text

What the operator did

string

recognition_kind

required

Recognition kind

string

Allowed values: name_acknowledged preference_anticipated relationship_remembered gesture_offered upgrade_provided amenity_provided personal_note_left birthday_anniversary_marked repeat_visit_acknowledged vip_treatment_initiated other

recognition_subject_text

What was recognised

string

stay_id

Stay context (when applicable)

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.recognition_event",
  "properties": {
    "delivery_visibility": "visible_to_guest",
    "recognition_kind": "name_acknowledged"
  },
  "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).