Incident types API

List and retrieve incident type configs (e.g. Safety Incident, Near Miss) used for incident reporting and templates. Includes qrSlug, default severity, and notification settings. All operations use the same API key as other v1 endpoints and return global or organization-scoped types.

v1

List incident types

Returns all incident types available to your organization (global and org-specific). Use activeOnly=true to return only active types.

Request

GET /api/v1/incident-types
Authorization: Bearer <your_token>

# Optional: only active
GET /api/v1/incident-types?activeOnly=true

Response

HTTP/1.1 200 OK
Content-Type: application/json

[
  {
    "id": "it_123",
    "name": "Safety Incident",
    "description": "Safety-related incident report",
    "color": "#dc3545",
    "icon": "ci-alert-triangle",
    "organizationId": null,
    "isDefault": true,
    "isActive": true,
    "isGlobal": true,
    "sortOrder": 0,
    "qrSlug": "safety-incident",
    "visibilityEnabled": true,
    "reportableBy": "ALL_USERS",
    "defaultSeverity": "MEDIUM",
    "notifySettings": "ASSIGNED_USER",
    "requiresImmediateNotification": false,
    "createdAt": "2026-01-10T09:00:00.000Z",
    "updatedAt": "2026-01-10T09:00:00.000Z"
  }
]

Get an incident type

Returns a single incident type by ID. The type must be global or belong to your organization.

Request

GET /api/v1/incident-types/{incidentTypeId}
Authorization: Bearer <your_token>

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "it_123",
  "name": "Safety Incident",
  "description": "Safety-related incident report",
  "color": "#dc3545",
  "icon": "ci-alert-triangle",
  "organizationId": null,
  "isDefault": true,
  "isActive": true,
  "isGlobal": true,
  "sortOrder": 0,
  "qrSlug": "safety-incident",
  "visibilityEnabled": true,
  "reportableBy": "ALL_USERS",
  "defaultSeverity": "MEDIUM",
  "notifySettings": "ASSIGNED_USER",
  "requiresImmediateNotification": false,
  "createdAt": "2026-01-10T09:00:00.000Z",
  "updatedAt": "2026-01-10T09:00:00.000Z"
}

Response fields

Each incident type includes id, name, description, color, icon, organizationId, isDefault, isActive, isGlobal, sortOrder, qrSlug, visibilityEnabled, reportableBy, defaultSeverity, notifySettings, requiresImmediateNotification, createdAt, updatedAt.

Rate limits

Same as other v1 APIs (per API key). See Error Handling for details.

Top