List incidents
GET/api/v1/incidents
Lists the organization's incidents, newest first. Paged with limit
(default 50) and offset; there is no total count.
Permission (API-key scope): oncall:incident:read.
Authorization
bearerAuth(oncall:incident:read)apiKeyHeader(oncall:incident:read)
Parameters
Query parameters
statusIncidentStatusOnly incidents in this status.limitintegerPage size. 0 or omitted means 50; more than 500 returns 500. Anything but a whole number of 0 or more is refused (400VALIDATION_FAILED, fieldlimit).offsetintegerHow many items to skip. Anything but a whole number of 0 or more is refused (400VALIDATION_FAILED, fieldoffset).
Responses
200
A page of incidents.
dataarray of Incident requiredShow Incident properties
idstring requiredorg_idstringnumberinteger requiredSequential number within the organization.titlestring requiredsummarystringseverityIncidentSeverity requiredstatusIncidentStatus requiredcommander_idstringstarted_atstring (date-time) requiredidentified_atstring (date-time)resolved_atstring (date-time)timelinearray of IncidentTimelineEntryThe timeline entries, oldest first. Only in the answer of Get an incident.Show IncidentTimelineEntry properties
idstringincident_idstringauthor_idstringstatusstringThe incident's status when the entry was written.messagestringcreated_atstring (date-time)
created_atstring (date-time)updated_atstring (date-time)versionintegerGoes up by one on every edit of the title, summary, severity or commander (not on acknowledge or resolve). Send it with an update to refuse the edit if someone else changed the incident first.
successboolean required
400
limit or offset is not a whole number of 0 or more (VALIDATION_FAILED).
errorobject requiredcodestring requiredmessagestring requiredrequest_idstringThe request'sX-Request-ID. Quote it to support.detailsarray of object requiredfieldstringmessagestring
401
No API key was sent, or it is unknown, revoked or expired (UNAUTHORIZED).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThe request'sX-Request-ID. Quote it to support.
403
The key lacks the scope this endpoint needs (FORBIDDEN).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThe request'sX-Request-ID. Quote it to support.
429
Too many requests (RATE_LIMITED). Wait Retry-After seconds.
Retry-AfterintegerSeconds to wait.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThe request'sX-Request-ID. Quote it to support.
500
Something went wrong on EvoHub's side (INTERNAL_ERROR). Retry later.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThe request'sX-Request-ID. Quote it to support.
Example request
curl -X GET 'https://evohub.io/api/v1/incidents' \
-H 'Authorization: Bearer <TOKEN>'
