Skip to content
aerandil.com
GitHub

Read Spa service

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

Read an existing instance.

A bookable treatment offering: price, service duration, and the provider-blocking buffer pair — pre time (room setup) and clean-up time (turnover) — that every major spa system models (Book4Time Pre Time / Clean-up Time, Zenoti recovery_time, Mindbody PrepTime / FinishTime). All three are snapshotted onto the appointment at booking, so catalogue edits never rewrite booking history. Distinct from service_item (POS catalogue row, no duration or resourcing) and from wellness_modality (taxonomy + licensing, proposal 0005) — the optional spa_service_for_modality link carries the clinical-licensing gate into book_appointment.

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.spa_service
properties
required
object
active
required
Bookable
boolean
cleanup_time_minutes
required
Provider-blocking turnover time after the service (linen / sanitise)
integer
code
required
Service code
string
couples
required
Couples service (two guests, one capacity-2 room, two appointments)
boolean
description
Guest-facing description
string
duration_minutes
required
Service duration in minutes (guest-facing treatment time)
integer
kind
required
Treatment taxonomy (ISPA / CBRE reporting mix)
string
Allowed values: massage facial body_treatment nail hair hydrotherapy wellness_session other
name
required
Service name
string
pre_time_minutes
required
Provider-blocking setup time before the service (room prep)
integer
price
required
Spa service price

List price (snapshotted onto the appointment at booking)

object
amount
required
string format: decimal
currency
required
string format: iso-4217
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.spa_service",
  "properties": {
    "kind": "massage"
  },
  "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).