Skip to content
aerandil.com
GitHub

Read Desk session

GET
/v1/object-types/hospitality.desk_session/objects/{id}
curl --request GET \
  --url https://api.aerandil.com/v1/object-types/hospitality.desk_session/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

One shift at the front desk: opened when a member of staff signs in through the identity provider, bound to the property they work at, and handed between that property’s desk staff by passcode without signing out. Every hand-over (desk_session.switched) and every re-proof of a passcode before a sensitive verb (desk_session.stepped_up) is an event on it, under the acting person’s own principal. Holds no credential: the bearer tokens are the kernel’s, minted per person and bounded by shift_ends_at.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Object id (UUID v7, server-generated at create time).

Query Parameters

Section titled “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

Section titled “Responses”

200

Section titled “200”

Object found.

Media typeapplication/json
object
created_at
required
string format: date-time
id
required
string format: uuid
object_type
required
Allowed value: hospitality.desk_session
properties
required
object
closed_at
Closed at (UTC)
string format: date-time
hands_changed_at
When the desk last changed hands — opened, or a colleague switched in. A step-up on the same person's session does not move it; bearers minted before it are superseded
string format: date-time
id
required
Session reference
string
last_proven_at
When the person at the desk last re-proved their passcode
string format: date-time
opened_at
required
Opened at (UTC)
string format: date-time
outlet_id
The outlet whose till the session is

Set when the session is a till at one of the property’s outlets rather than the front desk: a till is held and handed on by the F&B floor’s roles (server, F&B manager), the front desk by the front office’s, never the one by the other. Absent = the front desk.

string format: uuid
shift_ends_at
required
Shift ends at (UTC) — no token minted for the session outlives it
string format: date-time
status
required
Status
string
Allowed values: open closed
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.desk_session",
  "properties": {
    "status": "open"
  },
  "scope": {
    "level": "tenant"
  }
}

Headers

Section titled “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

Section titled “404”

No object with that id (or soft-deleted).