v1

latestOpenAPI 3.1.02026-07-2466150275.0 KB
Incidents

Search Incidents

Search for incidents that match the provided search terms.

Keywords are searched for in the id, user id, title, status, severity, site name, site address, site city, _and site country fields.

Additional explicit filters are also supported

get/v1/incident/

Query parameters

querystring nullable
skipinteger nullable
limitinteger nullable
sort_direction'asc' | 'desc'

Direction to sort the sort_column - ascending or descending.

date_startstring date-time nullable
date_cut_offstring date-time nullable
sort_column'updated_at' | 'created_at' | 'id' | 'incident_date'

Sort columns for incident search.

Extends DefaultSortColumn with incident_date (when the incident occurred), which differs from created_at (when the row was logged in the system, often days/weeks later).

statusstring nullable
project_idinteger nullable
user_idinteger nullable
is_archivedboolean nullable

Response

Successful Response

errorboolean

A boolean error indicator.

messagestring nullable

Optional message.