Sign in

v59

latestOpenAPI 3.0.2raw.githubusercontent.com2026-08-06261120479.1 KB
Incidents

List Incidents

Retrieve incident summaries, newest first. Reads from the database, so closed incidents are included as well. Only incidents whose source object is readable by the caller are returned.

get/v1/incidents

Query parameters

objectIdinteger

Return only incidents created on given source object (0 or absent for all objects).

statestring

Comma-separated list of incident states to include (absent for all states).

fromstring

Return only incidents created at or after this point in time.

tostring

Return only incidents created at or before this point in time.

limitinteger

Maximum number of incidents to return (default 1000, maximum 10000).

Response

Successful retrieval of incidents.

idinteger

Unique incident identifier.

stateinteger

Incident state: 0 open, 1 in progress, 2 blocked, 3 resolved, 4 closed.

stateNamestring

Human-readable incident state name.

titlestring

Incident title (up to 255 characters).

sourceObjectIdinteger

ID of object the incident was created on.

sourceObjectNamestring

Name of the source object.

assignedUserIdinteger

ID of user the incident is assigned to, or 0 when unassigned.

assignedUserNamestring

Login name of assigned user. Unassigned incidents must be detected by testing assignedUserId for 0, not by matching on this name - user ID 0 resolves to the built-in "system" account.

alarmCountinteger

Number of alarms linked to the incident.

creationTimestring date-time

Incident creation time.

lastChangeTimestring date-time

Time of last incident change.