Read Room

GET

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

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

Read an existing instance.

A physical room. Rooms always belong to a property and are linked to a room type. State is three orthogonal axes: housekeeping_status (the cleaning axis), occupancy (system truth, written by check-in / check-out / room moves), and the attendant-observed occupancy pair whose disagreement with system occupancy derives a room_discrepancy. Out-of-order / out-of-service are dated room_status_block records, not statuses here.

Authorizations

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

properties

required

object

bed_configuration

How the room's convertible beds are made up now: joined (one double or king) or split (two singles); absent when they do not convert or nobody recorded it

string

Allowed values: joined split

code

Vendor-alignment room code (tenant-unique; connector mappings resolve by it)

string

connecting_to

Connecting to room number

string

features

Features

Array<string>

floor

Floor

string

housekeeping_status

required

Housekeeping status (cleaning axis)

string

Allowed values: dirty pickup clean inspected

number

required

Room number

string

observed_at

When the observation was reported

string format: date-time

observed_occupancy

Attendant-observed occupancy (discrepancy comparator)

string

Allowed values: vacant occupied

observed_persons

Attendant-observed occupant count

integer

occupancy

required

System occupancy (front-office truth)

string

Allowed values: vacant occupied

reader_code

The code the room's QR / NFC reader carries (unique within the property)

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.room",
  "properties": {
    "bed_configuration": "joined",
    "housekeeping_status": "dirty",
    "observed_occupancy": "vacant",
    "occupancy": "vacant"
  },
  "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).