Read Public area

GET

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

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

Read an existing instance.

A place in the house that is not a guest room — a lobby, a corridor, a lift, the pool, the gym, the staff canteen — whose cleaning and inspection are housekeeping tasks linked housekeeping_task_for_area (hubOS’s common zones). code is the house’s business key for it (register_public_area upserts by it); kind is what a checklist template names (applies_to_area_kind), so every corridor shares one list; reader_code is what its QR / NFC reader carries, unique in the house across rooms and areas (set_public_area_reader_code) — the handset scans it and asks the object search for an eq on reader_code. An active area gets one public_area_clean per business date from generate_housekeeping_tasks; a retired one gets nothing and carries no reader code.

Authorizations

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

properties

required

object

code

required

The house's code for the area ("LOBBY", "C3-EAST")

string

floor

The floor it is on, in the rooms' own words (a room's `floor`)

string

kind

required

What kind of place it is — what a checklist template names

string

Allowed values: lobby corridor lift stairwell pool gym spa_area restaurant_floor toilets back_of_house exterior other

name

required

What the floor calls it ("Main lobby", "Third-floor corridor, east")

string

reader_code

The code the area's QR / NFC reader carries (unique within the property, across rooms and areas)

string

retired_at

When the area was retired (present while retired)

string format: date-time

status

required

Active (cleaned daily, scannable) or retired

string

Allowed values: active retired

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.public_area",
  "properties": {
    "kind": "lobby",
    "status": "active"
  },
  "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).