Skip to content

List Incidents

GET /api/v1/incidents

Authentication options declared in the contract include user cookie session or bearer service token.

The shared authentication policy requires incidents:read. Resource access also depends on the caller’s role, organization, camera grants, and the operation’s validation.

Authentication and permissions explains tokens, cookies, CSRF, and workspace context.

Name Location Required Type Description and constraints
streamId query No string (uuid) or null
ruleType query No string or null
status query No IncidentStatusFilter or null
severity query No RuleSeverity or null
startTime query No string (date-time) or null
endTime query No string (date-time) or null
limit query No integer minimum 1. maximum 500. default 100
offset query No integer minimum 0. maximum 1000000. default 0
X-EyesOnIt-Session-Id header No string (uuid) The sessionId the caller expects. Required when switching workspaces and for cookie requests after workspace rotation. A mismatched value returns 409 with X-EyesOnIt-Workspace-Changed: 1. Bootstrap with getCurrentPrincipal; never replay a mutation automatically after changing context. Bearer clients do not use this header.

Set the connection variables described in Get started. Replace each additional EOI_… variable with the parameter value for this request. This template sends the request when run.

Terminal window
curl --fail-with-body --silent --show-error \
--header "Authorization: Bearer ${EOI_SERVICE_TOKEN}" \
"${EOI_API_BASE_URL}/incidents"

The table records responses declared by the OpenAPI contract. See Errors and status codes for the runtime error envelope and shared failures.

Status Description Media type Body
200 Successful Response application/json IncidentPageResponse
422 Validation Error application/json HTTPValidationError

Operation identifier listIncidents. Browse Incidents and evidence.

Image preview