Skip to content

Get a crisis alert

Safety module

GET/crisis-alerts/{id}crisisAlerts.get

A crisis alert broadcast to a project. Returns one crisis alert with its `ETag`. A crisis alert the caller may not see returns 404.

  • Requires the capability safety.incident.read.
  • OAuth scopes: safety.
  • Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.

Path and query parameters

crisisAlerts.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the crisis alert.
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_]*)*$

Response 200: CrisisAlert

crisisAlerts.get: CrisisAlert
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the crisis alert.
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.
messagestringYesAlert message.Constraints: length 1 to 300
issued_atstring (date-time)YesWhen the alert was issued.
ended_atstring (date-time) | nullYesWhen the alert was cleared.
emergency_codestringYesCanon emergency code announced.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
{
  "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",
  "message": "Weather hold: clear the north lawn.",
  "issued_at": "2026-10-08T14:30:00Z",
  "ended_at": "2026-10-08T14:30:00Z",
  "emergency_code": "CODE_RED"
}

Code samples

curl -X GET "$XOS_BASE_URL/crisis-alerts/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.crisisAlerts.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.crisis_alerts.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos crisis-alerts get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f