Read Person

GET

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

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

Read an existing instance.

An individual person known to the hospitality system — guest, local, member, or any combination across a stay’s lifecycle. Persons are tenant-wide so loyalty, recognition, and history follow them across the portfolio. The ‘guest’ label is a role carried on reservation_for_guest and on a stay; the same person may also be a local (visiting a venue without a reservation), a member (enrolled in a membership-club program), or all three.

Authorizations

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

properties

required

object

address

Person address

The guest’s own postal address. Required on any tax invoice above the property’s simplified-invoice threshold — reg 14(1)(e) of the UK VAT Regulations 1995 wants “the name and address of the person to whom the goods or services are supplied”, and §14(4) Nr. 1 UStG the same. Snapshotted onto the document at issue.

object

city

required

string

country

required

string

line1

required

string

line2

string

postal_code

string

region

string

consent

Person consent

Marketing consent

object

marketing_email_consented_at

string format: date-time

marketing_email_withdrawn_at

string format: date-time

marketing_sms_consented_at

string format: date-time

marketing_sms_withdrawn_at

string format: date-time

method

string

Allowed values: web_form check_in_kiosk front_desk email_double_opt_in phone import other

profiling_consented_at

string format: date-time

profiling_withdrawn_at

string format: date-time

date_of_birth

Date of birth

string format: date

dietary_observance

Faith-driven dietary requirement (reveals religious observance)

Array<string>

Allowed values: halal kosher jain hindu_vegetarian buddhist_vegetarian eastern_orthodox_fasting other_religious

direct_stays

Direct-channel checked-out stays (projection)

integer

email

Email

string

external_ref

Source-system key for connector-minted persons

string

family_name

Family name

string

given_name

Given name

string

last_stay_date

Most recent stay departure (projection)

string format: date

last_stay_date_computed_at

Last stay date refresh timestamp

string format: date-time

lifetime_value

Person lifetime value

Lifetime value (projection over folio history)

object

amount

required

string format: decimal

currency

required

string format: iso-4217

lifetime_value_computed_at

Lifetime value refresh timestamp

string format: date-time

loyalty_id

Loyalty ID

string

nationality

Nationality (ISO 3166-1 alpha-2)

string

phone

Phone

string

preferences

Person preferences

Preferences

object

connecting_room_ok

boolean

dietary

Array<string>

frequents_venues

Array<string>

frequents_venues_computed_at

string format: date-time

language

string

observed_host_notes

string

pillow

string

preferred_amenity_brands

Array<string>

quiet_room

boolean

room_floor_preference

string

Allowed values: low mid high any

room_temperature_c

string format: decimal

seating_preference

string

relationship_context

Person relationship context

Relationship context (Tier 1.4 / 2 §D.2)

object

important_dates

Array<object>

object

date_of_year

required

string

notes

string

occasion

required

string

Allowed values: birthday anniversary wedding child_birthday first_visit_anniversary other

year_started

integer

language_secondary

string

local_status

string

Allowed values: not_local observed_local known_regular named_recognised

local_status_computed_at

string format: date-time

mobility_considerations

string

occupation

string

resolution_status

Identity-resolution status (proposal 0027)

string

Allowed values: active merged_subordinate

tax_identifier

Tax identifier

A personal tax number where a jurisdiction prints one on a guest’s invoice. Rare in the UK; ordinary in parts of southern Europe and Latin America.

string

total_stays

Total checked-out stays (projection)

integer

total_stays_computed_at

Total stays refresh timestamp

string format: date-time

vip_recognition

Person vip recognition

VIP recognition assignment (proposal 0025)

object

assigned_at

string format: date-time

is_published_to_member

required

boolean

tier

required

string

Allowed values: standard silver gold platinum ambassador

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.person",
  "properties": {
    "consent": {
      "method": "web_form"
    },
    "dietary_observance": [
      "halal"
    ],
    "preferences": {
      "room_floor_preference": "low"
    },
    "relationship_context": {
      "important_dates": [
        {
          "occasion": "birthday"
        }
      ],
      "local_status": "not_local"
    },
    "resolution_status": "active",
    "vip_recognition": {
      "tier": "standard"
    }
  },
  "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).