Skip to main content
GET
/
v1
/
incidents
List incidents
curl --request GET \
  --url https://api.rootly.com/v1/incidents \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "type": "incidents",
      "attributes": {
        "title": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "id": "<string>",
        "sequential_id": 123,
        "kind": "<string>",
        "slug": "<string>",
        "parent_incident_id": "<string>",
        "duplicate_incident_id": "<string>",
        "summary": "<string>",
        "private": false,
        "source": "<string>",
        "status": "<string>",
        "url": "<string>",
        "short_url": "<string>",
        "public_title": "<string>",
        "user": {},
        "severity": {
          "data": {
            "id": "<string>",
            "type": "severities",
            "attributes": {
              "name": "<string>",
              "created_at": "<string>",
              "updated_at": "<string>",
              "slug": "<string>",
              "description": "<string>",
              "color": "<string>",
              "position": 123,
              "notify_emails": [
                "<string>"
              ],
              "slack_channels": [
                {
                  "id": "<string>",
                  "name": "<string>"
                }
              ],
              "slack_aliases": [
                {
                  "id": "<string>",
                  "name": "<string>"
                }
              ]
            }
          },
          "included": [
            {
              "id": "<string>",
              "type": "<string>",
              "attributes": {},
              "relationships": {}
            }
          ]
        },
        "environments": [
          {
            "data": {
              "id": "<string>",
              "type": "environments",
              "attributes": {
                "name": "<string>",
                "created_at": "<string>",
                "updated_at": "<string>",
                "slug": "<string>",
                "description": "<string>",
                "notify_emails": [
                  "<string>"
                ],
                "color": "<string>",
                "position": 123,
                "slack_channels": [
                  {
                    "id": "<string>",
                    "name": "<string>"
                  }
                ],
                "slack_aliases": [
                  {
                    "id": "<string>",
                    "name": "<string>"
                  }
                ],
                "properties": [
                  {
                    "catalog_property_id": "<string>",
                    "value": "<string>"
                  }
                ]
              }
            },
            "included": [
              {
                "id": "<string>",
                "type": "<string>",
                "attributes": {},
                "relationships": {}
              }
            ]
          }
        ],
        "incident_types": [
          {
            "data": {
              "id": "<string>",
              "type": "incident_types",
              "attributes": {
                "name": "<string>",
                "created_at": "<string>",
                "updated_at": "<string>",
                "slug": "<string>",
                "description": "<string>",
                "color": "<string>",
                "position": 123,
                "notify_emails": [
                  "<string>"
                ],
                "slack_channels": [
                  {
                    "id": "<string>",
                    "name": "<string>"
                  }
                ],
                "slack_aliases": [
                  {
                    "id": "<string>",
                    "name": "<string>"
                  }
                ],
                "properties": [
                  {
                    "catalog_property_id": "<string>",
                    "value": "<string>"
                  }
                ]
              }
            },
            "included": [
              {
                "id": "<string>",
                "type": "<string>",
                "attributes": {},
                "relationships": {}
              }
            ]
          }
        ],
        "services": [
          {
            "data": {
              "id": "<string>",
              "type": "services",
              "attributes": {
                "name": "<string>",
                "created_at": "<string>",
                "updated_at": "<string>",
                "slug": "<string>",
                "description": "<string>",
                "public_description": "<string>",
                "notify_emails": [
                  "<string>"
                ],
                "color": "<string>",
                "position": 123,
                "backstage_id": "<string>",
                "external_id": "<string>",
                "pagerduty_id": "<string>",
                "opsgenie_id": "<string>",
                "cortex_id": "<string>",
                "service_now_ci_sys_id": "<string>",
                "github_repository_name": "<string>",
                "github_repository_branch": "<string>",
                "gitlab_repository_name": "<string>",
                "gitlab_repository_branch": "<string>",
                "kubernetes_deployment_name": "<string>",
                "environment_ids": [
                  "<string>"
                ],
                "service_ids": [
                  "<string>"
                ],
                "owner_group_ids": [
                  "<string>"
                ],
                "owner_user_ids": [
                  123
                ],
                "alert_urgency_id": "<string>",
                "escalation_policy_id": "<string>",
                "alerts_email_enabled": true,
                "alerts_email_address": "<string>",
                "slack_channels": [
                  {
                    "id": "<string>",
                    "name": "<string>"
                  }
                ],
                "slack_aliases": [
                  {
                    "id": "<string>",
                    "name": "<string>"
                  }
                ],
                "alert_broadcast_enabled": true,
                "alert_broadcast_channel": {
                  "id": "<string>",
                  "name": "<string>"
                },
                "incident_broadcast_enabled": true,
                "incident_broadcast_channel": {
                  "id": "<string>",
                  "name": "<string>"
                },
                "properties": [
                  {
                    "catalog_property_id": "<string>",
                    "value": "<string>"
                  }
                ]
              }
            },
            "included": [
              {
                "id": "<string>",
                "type": "<string>",
                "attributes": {},
                "relationships": {}
              }
            ]
          }
        ],
        "functionalities": [
          {
            "data": {
              "id": "<string>",
              "type": "functionalities",
              "attributes": {
                "name": "<string>",
                "created_at": "<string>",
                "updated_at": "<string>",
                "slug": "<string>",
                "description": "<string>",
                "public_description": "<string>",
                "notify_emails": [
                  "<string>"
                ],
                "color": "<string>",
                "backstage_id": "<string>",
                "external_id": "<string>",
                "pagerduty_id": "<string>",
                "opsgenie_id": "<string>",
                "opsgenie_team_id": "<string>",
                "cortex_id": "<string>",
                "service_now_ci_sys_id": "<string>",
                "position": 123,
                "environment_ids": [
                  "<string>"
                ],
                "service_ids": [
                  "<string>"
                ],
                "owner_group_ids": [
                  "<string>"
                ],
                "owner_user_ids": [
                  123
                ],
                "escalation_policy_id": "<string>",
                "slack_channels": [
                  {
                    "id": "<string>",
                    "name": "<string>"
                  }
                ],
                "slack_aliases": [
                  {
                    "id": "<string>",
                    "name": "<string>"
                  }
                ],
                "properties": [
                  {
                    "catalog_property_id": "<string>",
                    "value": "<string>"
                  }
                ]
              }
            },
            "included": [
              {
                "id": "<string>",
                "type": "<string>",
                "attributes": {},
                "relationships": {}
              }
            ]
          }
        ],
        "groups": [
          {
            "data": {
              "id": "<string>",
              "type": "groups",
              "attributes": {
                "name": "<string>",
                "created_at": "<string>",
                "updated_at": "<string>",
                "slug": "<string>",
                "description": "<string>",
                "notify_emails": [
                  "<string>"
                ],
                "color": "<string>",
                "position": 123,
                "backstage_id": "<string>",
                "external_id": "<string>",
                "pagerduty_id": "<string>",
                "pagerduty_service_id": "<string>",
                "opsgenie_id": "<string>",
                "victor_ops_id": "<string>",
                "pagertree_id": "<string>",
                "cortex_id": "<string>",
                "service_now_ci_sys_id": "<string>",
                "user_ids": [
                  123
                ],
                "admin_ids": [
                  123
                ],
                "alerts_email_enabled": true,
                "alerts_email_address": "<string>",
                "alert_urgency_id": "<string>",
                "slack_channels": [
                  {
                    "id": "<string>",
                    "name": "<string>"
                  }
                ],
                "slack_aliases": [
                  {
                    "id": "<string>",
                    "name": "<string>"
                  }
                ],
                "alert_broadcast_enabled": true,
                "alert_broadcast_channel": {
                  "id": "<string>",
                  "name": "<string>"
                },
                "incident_broadcast_enabled": true,
                "incident_broadcast_channel": {
                  "id": "<string>",
                  "name": "<string>"
                },
                "auto_add_members_when_attached": true,
                "properties": [
                  {
                    "catalog_property_id": "<string>",
                    "value": "<string>"
                  }
                ]
              }
            },
            "included": [
              {
                "id": "<string>",
                "type": "<string>",
                "attributes": {},
                "relationships": {}
              }
            ]
          }
        ],
        "labels": {},
        "slack_channel_id": "<string>",
        "slack_channel_name": "<string>",
        "slack_channel_url": "<string>",
        "slack_channel_short_url": "<string>",
        "slack_channel_deep_link": "<string>",
        "slack_channel_archived": true,
        "slack_last_message_ts": "<string>",
        "zoom_meeting_id": "<string>",
        "zoom_meeting_start_url": "<string>",
        "zoom_meeting_join_url": "<string>",
        "zoom_meeting_password": "<string>",
        "zoom_meeting_pstn_password": "<string>",
        "zoom_meeting_h323_password": "<string>",
        "zoom_meeting_global_dial_in_numbers": [
          {
            "country": "<string>",
            "country_name": "<string>",
            "city": "<string>",
            "number": "<string>",
            "type": "<string>"
          }
        ],
        "google_drive_id": "<string>",
        "google_drive_parent_id": "<string>",
        "google_drive_url": "<string>",
        "google_meeting_id": "<string>",
        "google_meeting_url": "<string>",
        "microsoft_teams_meeting_id": "<string>",
        "microsoft_teams_meeting_url": "<string>",
        "microsoft_teams_channel_id": "<string>",
        "microsoft_teams_channel_name": "<string>",
        "microsoft_teams_channel_url": "<string>",
        "microsoft_teams_channel_short_url": "<string>",
        "microsoft_teams_chat_id": "<string>",
        "microsoft_teams_chat_url": "<string>",
        "microsoft_teams_team_id": "<string>",
        "google_chat_space_id": "<string>",
        "google_chat_space_name": "<string>",
        "google_chat_space_url": "<string>",
        "google_chat_space_short_url": "<string>",
        "google_chat_space_archived": true,
        "google_chat_space_domain_id": "<string>",
        "webex_meeting_id": "<string>",
        "webex_meeting_url": "<string>",
        "jira_issue_key": "<string>",
        "jira_issue_id": "<string>",
        "jira_issue_url": "<string>",
        "github_issue_id": "<string>",
        "github_issue_url": "<string>",
        "gitlab_issue_id": "<string>",
        "gitlab_issue_url": "<string>",
        "asana_task_id": "<string>",
        "asana_task_url": "<string>",
        "linear_issue_id": "<string>",
        "linear_issue_url": "<string>",
        "trello_card_id": "<string>",
        "trello_card_url": "<string>",
        "zendesk_ticket_id": "<string>",
        "zendesk_ticket_url": "<string>",
        "pagerduty_incident_id": "<string>",
        "pagerduty_incident_number": "<string>",
        "pagerduty_incident_url": "<string>",
        "opsgenie_incident_id": "<string>",
        "opsgenie_incident_url": "<string>",
        "opsgenie_alert_id": "<string>",
        "opsgenie_alert_url": "<string>",
        "service_now_incident_id": "<string>",
        "service_now_incident_key": "<string>",
        "service_now_incident_url": "<string>",
        "mattermost_channel_id": "<string>",
        "mattermost_channel_name": "<string>",
        "mattermost_channel_url": "<string>",
        "confluence_page_id": "<string>",
        "confluence_page_url": "<string>",
        "datadog_notebook_id": "<string>",
        "datadog_notebook_url": "<string>",
        "shortcut_story_id": "<string>",
        "shortcut_story_url": "<string>",
        "shortcut_task_id": "<string>",
        "shortcut_task_url": "<string>",
        "motion_task_id": "<string>",
        "motion_task_url": "<string>",
        "clickup_task_id": "<string>",
        "clickup_task_url": "<string>",
        "victor_ops_incident_id": "<string>",
        "victor_ops_incident_url": "<string>",
        "quip_page_id": "<string>",
        "quip_page_url": "<string>",
        "sharepoint_page_id": "<string>",
        "sharepoint_page_url": "<string>",
        "airtable_base_key": "<string>",
        "airtable_table_name": "<string>",
        "airtable_record_id": "<string>",
        "airtable_record_url": "<string>",
        "freshservice_ticket_id": "<string>",
        "freshservice_ticket_url": "<string>",
        "freshservice_task_id": "<string>",
        "freshservice_task_url": "<string>",
        "mitigation_message": "<string>",
        "resolution_message": "<string>",
        "cancellation_message": "<string>",
        "scheduled_for": "<string>",
        "scheduled_until": "<string>",
        "muted_service_ids": [
          "<string>"
        ],
        "in_triage_by": {},
        "started_by": {},
        "mitigated_by": {},
        "resolved_by": {},
        "closed_by": {},
        "cancelled_by": {},
        "in_triage_at": "<string>",
        "started_at": "<string>",
        "detected_at": "<string>",
        "acknowledged_at": "<string>",
        "mitigated_at": "<string>",
        "resolved_at": "<string>",
        "closed_at": "<string>",
        "cancelled_at": "<string>"
      }
    }
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "prev": "<string>",
    "next": "<string>",
    "last": "<string>"
  },
  "meta": {
    "current_page": 123,
    "next_page": 123,
    "prev_page": 123,
    "total_count": 123,
    "total_pages": 123,
    "next_cursor": "<string>"
  },
  "included": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {},
      "relationships": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page[after]
string

The cursor to fetch results using cursor pagination. A cursor is provided in meta.next_cursor in the response.

​
page[number]
integer
​
page[size]
integer
​
filter[search]
string
​
filter[kind]
string
​
filter[status]
string
​
filter[private]
string
​
filter[user_id]
integer
​
filter[severity]
string
​
filter[severity_id]
string
​
filter[labels]
string
​
filter[types]
string
​
filter[type_ids]
string
​
filter[environments]
string
​
filter[environment_ids]
string
​
filter[functionalities]
string
​
filter[functionality_ids]
string
​
filter[functionality_names]
string
​
filter[services]
string
​
filter[service_ids]
string
​
filter[service_names]
string
​
filter[teams]
string
​
filter[team_ids]
string
​
filter[team_names]
string
​
filter[cause]
string
​
filter[cause_ids]
string
​
filter[custom_field_selected_option_ids]
string
​
filter[slack_channel_id]
string
​
filter[sequential_id]
string

Filter by the human-readable incident number (the 123 in INC-123).

​
filter[created_at][gt]
string
​
filter[created_at][gte]
string
​
filter[created_at][lt]
string
​
filter[created_at][lte]
string
​
filter[updated_at][gt]
string
​
filter[updated_at][gte]
string
​
filter[updated_at][lt]
string
​
filter[updated_at][lte]
string
​
filter[started_at][gt]
string
​
filter[started_at][gte]
string
​
filter[started_at][lt]
string
​
filter[started_at][lte]
string
​
filter[detected_at][gt]
string
​
filter[detected_at][gte]
string
​
filter[detected_at][lt]
string
​
filter[detected_at][lte]
string
​
filter[acknowledged_at][gt]
string
​
filter[acknowledged_at][gte]
string
​
filter[acknowledged_at][lt]
string
​
filter[acknowledged_at][lte]
string
​
filter[mitigated_at][gt]
string
​
filter[mitigated_at][gte]
string
​
filter[mitigated_at][lt]
string
​
filter[mitigated_at][lte]
string
​
filter[resolved_at][gt]
string
​
filter[resolved_at][gte]
string
​
filter[resolved_at][lt]
string
​
filter[resolved_at][lte]
string
​
filter[closed_at][gt]
string
​
filter[closed_at][gte]
string
​
filter[closed_at][lt]
string
​
filter[closed_at][lte]
string
​
filter[in_triage_at][gt]
string
​
filter[in_triage_at][gte]
string
​
filter[in_triage_at][lt]
string
​
filter[in_triage_at][lte]
string
​
filter[kind][eq]
string
​
filter[kind][not_eq]
string
​
filter[kind][in]
string
​
filter[kind][not_in]
string
​
filter[status][eq]
string
​
filter[status][not_eq]
string
​
filter[status][in]
string
​
filter[status][not_in]
string
​
filter[private][eq]
string
​
filter[private][not_eq]
string
​
filter[private][in]
string
​
filter[private][not_in]
string
​
filter[user_id][eq]
string
​
filter[user_id][not_eq]
string
​
filter[user_id][in]
string
​
filter[user_id][not_in]
string
​
filter[severity][eq]
string
​
filter[severity][not_eq]
string
​
filter[severity][in]
string
​
filter[severity][not_in]
string
​
filter[severity_id][eq]
string
​
filter[severity_id][not_eq]
string
​
filter[severity_id][in]
string
​
filter[severity_id][not_in]
string
​
filter[labels][eq]
string
​
filter[labels][not_eq]
string
​
filter[labels][in]
string
​
filter[labels][not_in]
string
​
filter[zendesk_ticket_id][eq]
string
​
filter[zendesk_ticket_id][not_eq]
string
​
filter[zendesk_ticket_id][in]
string
​
filter[zendesk_ticket_id][not_in]
string
​
filter[sequential_id][eq]
string
​
filter[sequential_id][not_eq]
string
​
filter[sequential_id][in]
string
​
filter[sequential_id][not_in]
string
​
filter[types][eq]
string
​
filter[types][not_eq]
string
​
filter[types][in]
string
​
filter[types][not_in]
string
​
filter[type_ids][eq]
string
​
filter[type_ids][not_eq]
string
​
filter[type_ids][in]
string
​
filter[type_ids][not_in]
string
​
filter[environments][eq]
string
​
filter[environments][not_eq]
string
​
filter[environments][in]
string
​
filter[environments][not_in]
string
​
filter[environment_ids][eq]
string
​
filter[environment_ids][not_eq]
string
​
filter[environment_ids][in]
string
​
filter[environment_ids][not_in]
string
​
filter[services][eq]
string
​
filter[services][not_eq]
string
​
filter[services][in]
string
​
filter[services][not_in]
string
​
filter[service_ids][eq]
string
​
filter[service_ids][not_eq]
string
​
filter[service_ids][in]
string
​
filter[service_ids][not_in]
string
​
filter[service_names][eq]
string
​
filter[service_names][not_eq]
string
​
filter[service_names][in]
string
​
filter[service_names][not_in]
string
​
filter[functionalities][eq]
string
​
filter[functionalities][not_eq]
string
​
filter[functionalities][in]
string
​
filter[functionalities][not_in]
string
​
filter[functionality_ids][eq]
string
​
filter[functionality_ids][not_eq]
string
​
filter[functionality_ids][in]
string
​
filter[functionality_ids][not_in]
string
​
filter[functionality_names][eq]
string
​
filter[functionality_names][not_eq]
string
​
filter[functionality_names][in]
string
​
filter[functionality_names][not_in]
string
​
filter[causes][eq]
string
​
filter[causes][not_eq]
string
​
filter[causes][in]
string
​
filter[causes][not_in]
string
​
filter[cause_ids][eq]
string
​
filter[cause_ids][not_eq]
string
​
filter[cause_ids][in]
string
​
filter[cause_ids][not_in]
string
​
filter[teams][eq]
string
​
filter[teams][not_eq]
string
​
filter[teams][in]
string
​
filter[teams][not_in]
string
​
filter[team_ids][eq]
string
​
filter[team_ids][not_eq]
string
​
filter[team_ids][in]
string
​
filter[team_ids][not_in]
string
​
filter[team_names][eq]
string
​
filter[team_names][not_eq]
string
​
filter[team_names][in]
string
​
filter[team_names][not_in]
string
​
sort
enum<string>

comma separated if needed. eg: created_at,updated_at

Available options:
created_at,
-created_at,
updated_at,
-updated_at,
started_at,
-started_at,
in_triage_at,
-in_triage_at,
mitigated_at,
-mitigated_at,
resolved_at,
-resolved_at
​
include
enum<string>

comma separated if needed. eg: sub_statuses,causes,subscribers

Available options:
sub_statuses,
causes,
subscribers,
roles,
slack_messages,
environments,
incident_types,
services,
functionalities,
groups,
events,
action_items,
custom_field_selections,
feedbacks,
incident_post_mortem,
alerts

Response

success

​
data
object[]
required
​
links
object
required
​
meta
object
required
​
included
object[]