Read Wellness modality

GET

/v1/object-types/hospitality.wellness_modality/objects/{id}

const url = 'https://api.aerandil.com/v1/object-types/hospitality.wellness_modality/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Read an existing instance.

A type of wellness service available at one or more venues. Distinct from service_item because modalities carry licensing context, evidence-level metadata, and capacity-model classification that the POS-catalogue shape does not type. The requires_medical_licensing flag plus the assessment side’s structural payload-empty contract (commit 5) is the legal-architecture seam — clinical records stay in the external system; Aerandil holds only the opaque pointer.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.wellness_modality:read

Parameters

Path Parameters

required

string format: uuid

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

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

200

Object found.

application/json

object

created_at

required

string format: date-time

required

string format: uuid

object_type

required

Allowed value: hospitality.wellness_modality

properties

required

object

capacity_model

required

Capacity model

string

Allowed values: throughput slot session session_with_roster shared_zone

code

required

Modality code

string

contraindications_text

Operator's contraindications summary (not clinical screening)

string

description

Description

string

evidence_level

required

Evidence level (substantive-vs-gimmick filter)

string

Allowed values: well_evidenced emerging aesthetic_only

evidence_source_url

Evidence source URL (when the operator cites a specific base)

string

kind

required

Modality kind

string

Allowed values: cold_therapy heat_therapy contrast_therapy resistance_training cardiovascular mobility recovery_passive recovery_active diagnostic clinical_intervention mindfulness sleep_optimisation nutritional aesthetic other

licensing_jurisdiction

Licensing jurisdiction (free text — regulator authority)

string

name

required

Modality name

string

requires_medical_licensing

required

Booking requires external_record_reference (clinical seam)

boolean

typical_duration_minutes

Typical duration (minutes)

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_modality",
  "properties": {
    "capacity_model": "throughput",
    "evidence_level": "well_evidenced",
    "kind": "cold_therapy"
  },
  "scope": {
    "level": "tenant"
  }
}

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

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