Skip to main content

Read a Signals alert episode

MethodPath
GET/v1/signals/alerts/:episodeId

Shared authentication, project scope, and response conventions.

Reads one episode and its readings. :episodeId is the Signals episode id, not the Patient id. Ovok verifies the episode belongs to the caller's project and that the caller can read its Patient. Any missing episode, missing Patient mapping, cross-project result, or unreadable Patient is returned as the same 404 to avoid disclosing whether the record exists.

Requirement or resultDetails
Access policysignals_alerts:read and Patient read
Success200 with the episode, patientId, signalsPatientId, and noteCount
409 signals_episodes_disabledThe project's episodicAlerts setting is off.
404Episode is missing, outside the project, or tied to a Patient the caller cannot read.
curl --request GET \
--url 'https://api.sandbox.ovok.com/v1/signals/alerts/0b6f8c1e-2a4d-4e7b-9c3f-1d5e8a7b6c4d' \
--header "Authorization: Bearer ${OVOK_TOKEN}"