Skip to content

Read Wellness equipment

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

Read an existing instance.

A physical instance of a wellness modality. Decoupled from the modality concept because operators carry portable equipment that moves between venues and equipment that supports multiple modalities. Operator-side maintenance discipline (serial, install, service cadence) lives on the equipment row for compliance reporting on regulated equipment (HBOT chambers, cryo units).

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.wellness_equipment
properties
required
object
code
required
Equipment code
string
installed_at
Installed on
string format: date
is_portable
required
Portable (doesn't carry a stable venue link)
boolean
last_serviced_at
Last service date
string format: date
manufacturer
Manufacturer
string
modality_ref
required
Primary modality this equipment provides
string format: uuid
model
Model
string
name
required
Equipment name
string
next_service_due
Next service due (regulator inspection or maintenance)
string format: date
notes
Operator notes
string
serial_number
Serial number
string
service_cadence_days
Service cadence (days)
integer
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.wellness_equipment",
"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).