Skip to content

Read Service table

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

Read an existing instance.

A seatable unit within a service area — table, booth, bar-stool group. Carries capacity, a stable label, and an x/y position for the floor-plan render. Status follows the industry floor vocabulary: open_check seats it, settle_check marks it dirty, and dirty → available is a bussing update on the CRUD surface.

id
required
string format: uuid

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

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.

Object found.

Media typeapplication/json
object
created_at
required
string format: date-time
id
required
string format: uuid
object_type
required
Allowed value: hospitality.service_table
properties
required
object
capacity
required
Seats
integer
label
required
Table label
string
position_x
Floor-plan x position
string format: decimal
position_y
Floor-plan y position
string format: decimal
status
required
Floor status
string
Allowed values: available seated dirty reserved blocked
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.service_table",
"properties": {
"status": "available"
},
"scope": {
"level": "tenant"
}
}
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.

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