Skip to content
aerandil.com
GitHub

Read Appointment

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

Read an existing instance.

A timed-service booking: one guest × one service in a time window, with the price and buffer pair snapshotted from the spa_service at booking. Lifecycle: booked → confirmed → checked_in → in_service → completed → settled, with cancelled / no_show off-ramps — mutates only through the nine spa actions. booked_at is the business instant the booking was taken (pace and lead-time reads derive from it, the reservation discipline); start_at/end_at bound the treatment itself, and room occupancy extends to [start_at - pre_time, end_at + cleanup_time]. settle_appointment is settle_check’s twin: a room_charge tender posts one aggregated folio charge; every tender emits the enriched spa.appointment_settled event, which is the revenue row for card/cash walk-ins (no folio is minted for a POS sale).

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.appointment
properties
required
object
booked_at
required
When the booking was taken (business time — pace/lead-time reads)
string format: date-time
booked_by
required
Principal::stable_id() of the booking principal
string
cancellation_kind
Cancellation kind (required when cancelled; absent on no_show)
string
Allowed values: guest late operator
cancelled_at
When the appointment was cancelled or marked no-show
string format: date-time
checked_in_at
When the guest arrived at the spa desk
string format: date-time
cleanup_time_minutes
required
Turnover buffer snapshotted from the service at booking
integer
completed_at
When the treatment ended
string format: date-time
confirmed_at
When the guest reconfirmed
string format: date-time
end_at
required
Treatment end (start + service duration at booking)
string format: date-time
external_ref
Source-system key for replayed / connector-landed bookings
string
gratuity
Appointment gratuity

Voluntary gratuity added at settle (pass-through, not department revenue)

object
amount
required
string format: decimal
currency
required
string format: iso-4217
guest_kind
Who the client is to the property (in-house capture dimension)
string
Allowed values: hotel_guest member external
id
required
Appointment id
string
notes
Front-desk / therapist notes (may carry intake detail)
string
pre_time_minutes
required
Setup buffer snapshotted from the service at booking
integer
price
required
Appointment price

Price snapshotted from the service at booking

object
amount
required
string format: decimal
currency
required
string format: iso-4217
service_started_at
When the treatment actually began
string format: date-time
settled_at
When the appointment settled
string format: date-time
settlement_reference
PSP / drawer / platform reference for non-room tenders
string
start_at
required
Treatment start
string format: date-time
status
required
Appointment lifecycle status
string
Allowed values: booked confirmed checked_in in_service completed settled cancelled no_show
tender
Settlement tender (absent until settle; shares the check vocabulary)
string
Allowed values: room_charge cash card comp external charge_to_key
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.appointment",
  "properties": {
    "cancellation_kind": "guest",
    "guest_kind": "hotel_guest",
    "status": "booked",
    "tender": "room_charge"
  },
  "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).