Skip to main content
GET
/
v1
/
incidents
List incidents
curl --request GET \
  --url https://api.example.com/v1/incidents

​
Overview

Returns a paginated list of incidents for the authenticated tenant. Use query parameters to filter by severity and status, or to control sort order and page size. Required role: Any authenticated user (viewer or above)

​
Query parameters

​
severity
string
Filter by severity level. One of: critical, high, medium, low.
​
status
string
Filter by incident status. One of: open, triaging, investigating, awaiting_approval, remediating, resolved, closed.
​
sort
string
default:"createdAt"
Field to sort results by. Currently supports createdAt.
​
order
string
default:"desc"
Sort order. One of: asc, desc.
​
limit
integer
default:"20"
Number of incidents to return per page. Maximum 100.
​
cursor
string
Cursor token from a previous response to fetch the next page. Omit for the first page.

​
Response

Returns 200 OK with a paginated list of incidents. 
{
  "incidents": [
    {
      "incidentId": "inc_01HX9VTPQR3KF8MZWBYD5N6JCE",
      "title": "Database latency spike on prod-db-01",
      "severity": "critical",
      "status": "investigating",
      "source": "automated",
      "createdAt": "2024-04-01T10:23:45Z"
    },
    {
      "incidentId": "inc_01HX9VTPQR3KF8MZWBYD5N6JCF",
      "title": "API gateway 5xx error rate elevated",
      "severity": "high",
      "status": "open",
      "source": "manual",
      "createdAt": "2024-04-01T09:15:00Z"
    }
  ],
  "count": 47,
  "cursor": "eyJpZCI6Imlu..."
}
FieldTypeDescription
incidentIdstringUnique identifier for the incident
titlestringShort description of the incident
severitystringSeverity level: critical, high, medium, or low
statusstringCurrent lifecycle status of the incident
sourcestringHow the incident was created: automated or manual
createdAtstringISO 8601 timestamp when the incident was created
countnumberTotal number of matching incidents across all pages
cursorstringCursor token for the next page. null if no more pages.

​
Examples

# List critical open incidents
curl "https://api.causeflow.ai/v1/incidents?severity=critical&status=open&limit=20" \
  -H "Authorization: Bearer <token>"