List incidents
/v1/incidentsReturns a page of incidents. Filters combine with AND. Use next_cursor to fetch the next page. Available to keys belonging to office staff and caregivers.
Query parameters
Number of objects to return, from 1 to 100.
The next_cursor from the previous page. Send the same filters with it.
Only return incidents with this follow-up status.
OpenMonitoringAwaitingFollowUpResolvedClosedOnly return incidents involving this patient.
Only return incidents involving this caregiver.
Only return resolved (true) or unresolved (false) incidents.
Only return objects created after this time (exclusive). ISO 8601 with a time zone.
Only return objects created before this time (exclusive). ISO 8601 with a time zone.
Only return objects last changed after this time (exclusive). ISO 8601 with a time zone. Use it for incremental sync: pass the newest updatedAt you already have.
Only return objects last changed before this time (exclusive). ISO 8601 with a time zone.
Response
200A page of results.
Always list.
The incidents on this page.
Show item attributesHide item attributes(31)
String representing the object's type. Always incident.
Unique identifier of the incident.
Short summary.
What happened.
When the incident happened.
Kind of incident.
FallMedicationBehavioralInjuryEquipmentAttendanceConductOthernullHow serious it was.
LowMediumHighCriticalnullWhere follow-up stands. New incidents start Open.
OpenMonitoringAwaitingFollowUpResolvedClosednullThe patient involved.
The caregiver involved.
The visit during which it happened.
What was done at the time.
Body part injured, if any.
Witness, if any.
Whether 911 or other emergency services were called.
Whether the patient went to hospital.
Hospital, if transported.
Whether the patient's physician was told.
Whether family was told.
Whether the incident must be reported to a regulator.
Whether follow-up is needed.
When follow-up is due.
Follow-up notes.
Whether the incident is resolved.
How it was resolved.
Whether only administrators can see it.
Who reported it.
When it was reported.
When it was resolved.
When the incident was created.
When the incident was last changed.
Pass as cursor to fetch the next page. null on the last page.
Whether another page exists.
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 |
|---|---|---|
| 400 | n/a | The request was malformed, a value was invalid, or it contained an unknown field (invalid_request, unknown_field). |
| 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). |
| 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.