Read Wellness protocol

GET

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

const url = 'https://api.aerandil.com/v1/object-types/hospitality.wellness_protocol/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_protocol/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

A prescribed pattern of modality sessions for a member. The non-clinical equivalent of a prescription. Distinct from coaching_plan because the protocol is a typed modality-pattern prescription (modality X, frequency Y, duration Z) and the coaching plan is a narrative trajectory. Both ship because operator practice observed treats them as separate.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.wellness_protocol: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_protocol

properties

required

object

completed_at

Actual completion

string format: date-time

duration_weeks

Protocol duration in weeks (null for open-ended)

integer

frequency_per_week

required

Sessions per week (0 admissible for one-off protocols)

integer

goals_text

Member's stated goals

string

required

Protocol id

string

is_active

required

Currently active (false on completion or early termination)

boolean

prescribed_at

required

When the protocol was prescribed

string format: date-time

prescribing_practitioner_text

Practitioner who prescribed (free text — staff or contractor)

string

progress_notes

Operator's running notes on member adherence + response

string

target_completion_date

Target completion

string format: date

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_protocol",
  "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).