Skip to content

List incident rows

Safety module

GET/incidentsincidents.list

An incident with dispatch. A critical incident cannot be relabeled and closed in one statement; closing requires sign-off. Returns a cursor page of incident rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

  • Requires the capability safety.incident.read.
  • OAuth scopes: safety.
  • Cursor-paginated: limit, cursor, fields, sort and filter apply.
  • Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.

Path and query parameters

incidents.list: Path and query parameters
FieldTypeRequiredDescription
limitLimitNoPage size. Default 50, maximum 200.Constraints: range 1 to 200
cursorCursorNoOpaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$
sortSortNoSort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$
filterFilterNoFilter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND.

Response 200: a page of Incident

incidents.list: Incident
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the incident.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
project_idstring (uuid)YesIdentifier of the project.
titlestringYesShort description.Constraints: length 1 to 300
occurred_atstring (date-time)YesWhen it happened.
zone_idstring (uuid) | nullYesIdentifier of the zone.
latitudenumber | nullYesWGS 84 latitude.Constraints: range -90 to 90
longitudenumber | nullYesWGS 84 longitude.Constraints: range -180 to 180
severity_enum_idstringYesSeverity: a row of the canon Incident Severity enumeration.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
incident_numberintegerYesNumber from the project's display key sequence.Constraints: range 1 to any
incident_state"Reported" | "Dispatched" | "Contained" | "Closed"YesIncident state.
reported_bystring (uuid) | nullYesIdentifier of the reporter, from the session.
closed_signed_off_bystring (uuid) | nullYesIdentifier of the person who signed off the closure.
accuracy_mnumber | nullYesHorizontal accuracy of the location in meters.
device_reported_atstring (date-time) | nullYesWhen the reporter filed it on the device, for a report queued offline.
closed_atstring (date-time) | nullYesWhen the incident moved to Closed, from its transition ledger.
{
  "data": [
    {
      "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "created_at": "2026-10-08T14:30:00Z",
      "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "updated_at": "2026-10-08T14:30:00Z",
      "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "title": "Guest Fall Near North Bar",
      "occurred_at": "2026-10-08T14:30:00Z",
      "zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "latitude": 25.7617,
      "longitude": -80.1918,
      "severity_enum_id": "ENM-097",
      "incident_number": 142,
      "incident_state": "Reported",
      "reported_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "closed_signed_off_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "accuracy_m": 8,
      "device_reported_at": "2026-10-08T14:30:00Z",
      "closed_at": "2026-10-08T14:30:00Z"
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/incidents" \
  -H "Authorization: Bearer $XOS_API_KEY"
for await (const row of xos.incidents.listAll()) {
  console.log(row);
}
for row in xos.incidents.list_all():
    print(row)
xos incidents list --all