Read Allergy alert

GET

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

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

Read an existing instance.

Person-attached structured record of a single food allergy: which EU 1169/2011-listed allergen (matching recipe.allergens so menu↔guest joins are trivial), how severe the documented reaction, how confident the diagnosis (self-reported → oral food challenge), and what the kitchen / front-of-house protocol should be. One alert per (person, allergen); persons with multiple allergies carry multiple alert rows. Pairs with recipe.allergens / recipe_ingredient.allergen_flags on the producer side and with external_record_reference on the clinical-record seam (Aerandil never carries the underlying diagnostic payload — see external_records.rs). The free-text dietary field on person.preferences is consumer-side lifestyle (vegan, kosher); allergen alerts live here so the medical surface stays structured.

Authorizations

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

properties

required

object

airborne_sensitive

Reaction possible from cooking vapour / particulate

boolean

allergen

Allergen (EU 1169/2011 Annex II vocabulary)

string

Allowed values: gluten crustaceans eggs fish peanuts soybeans milk nuts celery mustard sesame sulphites lupin molluscs

clinical_status

Diagnosis provenance

string

Allowed values: self_reported family_reported clinician_diagnosed skin_prick_confirmed specific_ige_confirmed oral_food_challenge_confirmed

cross_contact_sensitive

Kitchen must use separate equipment / surfaces

boolean

diagnosed_on

Diagnosis date

string format: date

emergency_action_plan_text

Operator-readable action plan (free text — clinical plan stays in `clinical_record_ref`)

string

epi_pen_required

Epinephrine on-person required (paired with severity ∈ {severe, life_threatening})

boolean

expires_on

When the alert becomes inactive (childhood allergies can be outgrown; null = no expiry)

string format: date

required

Alert id

string

last_verified_on

When the operator last re-confirmed the alert with the person

string format: date

notes

Operator notes (front-of-house phrasing, prior-incident references)

string

severity

Severity (operator-facing five-rung ladder)

string

Allowed values: intolerance mild moderate severe life_threatening

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.allergy_alert",
  "properties": {
    "allergen": "gluten",
    "clinical_status": "self_reported",
    "severity": "intolerance"
  },
  "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).