Retrieve an event
/v1/events/{id}Returns one event by ID. Available to keys belonging to office staff.
Path parameters
ID of the event.
Response
200The event.
String representing the object's type. Always event.
Unique identifier of the event.
Short summary.
What happened.
Category, as named in your agency's event types.
How serious it was.
LowMediumHighCriticalnullWhere follow-up stands.
OpenMonitoringAwaitingFollowUpResolvedClosednullWhen it happened.
The patient involved.
The caregiver involved.
The visit involved.
Attendance points this event counts for, if your agency uses a points policy.
What was done.
Outcome.
Whether follow-up is needed.
When follow-up is due.
Follow-up notes.
How it was resolved.
Whether only administrators can see it.
Who documented it.
When it was documented.
When it was resolved.
When the event was created.
When the event was last changed.
Response headers
Request-IdstringUnique ID of this request. Quote it when contacting support.RateLimit-LimitintegerRequests allowed in the current window.RateLimit-RemainingintegerRequests left in the current window.RateLimit-ResetintegerSeconds until the window resets.Errors
| Status | Code | Meaning |
|---|---|---|
| 401 | n/a | The API key is missing, malformed, expired or revoked (unauthorized). |
| 403 | n/a | The key is read-only (insufficient_scope), or its user's role cannot do this (forbidden). |
| 404 | n/a | No such object, or it is not visible to this key (not_found). |
| 429 | n/a | Too many requests (rate_limited). Wait for Retry-After seconds. |
| 500 | n/a | Something went wrong on our side (internal_error). Retry, and quote the request ID if it persists. |
Every error uses the same body. See Errors for the full list of codes.