Skip to content
aerandil.com
GitHub

Search Appointment

POST
/v1/object-types/hospitality.appointment/search
curl --request POST \
  --url https://api.aerandil.com/v1/object-types/hospitality.appointment/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "cursor": "example", "filters": [ { "property": "id", "type": "eq", "value": "example" } ], "limit": 1, "order": "asc", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "scope": { "level": "tenant" }, "sort_by": "created_at" }'

Search for instances. Filters eq, contains, gte and lte AND-compose; or / not are additive follow-ups. Pages with an opaque cursor; the +1 fetch returns has_more without a second round-trip. Ordered by sort_by (default created_at) in order (default ascending), id breaking ties; rows with no value for a property key sort last.

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”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
branch

Optional open-branch id. Search composes that branch’s copy-on-first-write overlay instead of main, so a preview reads its own hypothetical writes. Omit to read main.

string format: uuid
cursor

Opaque cursor from a prior response’s next_cursor. Pass back verbatim; do not introspect.

string
filters

Conjunctive list of predicates. Empty or omitted matches every row in scope, capped by limit.

Array
One of:
object
property
required
Allowed value: id
type
required
Allowed value: eq
value
required
string
limit

Page size. Server defaults to 50, silently clamps at 500 (AIP-158 §3).

integer
>= 1 <= 500
order

Direction of sort_by: asc (oldest / smallest first) or desc. A cursor is bound to the sort_by and order it was minted under; another pair is refused (422).

string
default: asc
Allowed values: asc desc
property_id

The house a desk stands in: keeps this property’s rows (property- or venue-scoped there) and every row scoped to no property (tenant, brand, portfolio), and drops a sibling house’s — the meaning property_id has on the event tail.

string format: uuid
scope
One of: discriminator: level
object
level
required
string
Allowed value: tenant
Allowed values: tenant
sort_by

What the page is ordered by: the row’s created_at or updated_at, or a property whose type orders — strings, enums and dates as text, ints, decimals and durations as numbers, datetimes as instants. Rows with no value sort last in either direction. A property the caller is not cleared to read is refused (403).

string
default: created_at
Allowed values: created_at updated_at id status start_at end_at pre_time_minutes cleanup_time_minutes booked_at booked_by guest_kind confirmed_at checked_in_at service_started_at completed_at settled_at cancelled_at cancellation_kind tender settlement_reference notes external_ref

Responses

Section titled “Responses”

200

Section titled “200”

Search results, ordered by (sort_by, id) in the requested order (ascending by default).

Media typeapplication/json
object
data
required
Array<object>
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
has_more
required
boolean
next_cursor

Cursor for the next page; omitted when the result set is exhausted.

string
Example
{
  "data": [
    {
      "object_type": "hospitality.appointment",
      "properties": {
        "cancellation_kind": "guest",
        "guest_kind": "hotel_guest",
        "status": "booked",
        "tender": "room_charge"
      },
      "scope": {
        "level": "tenant"
      }
    }
  ]
}

422

Section titled “422”

Validation error — unknown property or filter type mismatch.