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": {
        "id": "<string>",
        "sequential_id": 123,
        "title": "<string>",
        "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>",
              "slug": "<string>",
              "description": "<string>",
              "severity": "critical",
              "color": "<string>",
              "position": 123,
              "notify_emails": [
                "<string>"
              ],
              "slack_channels": [
                {}
              ],
              "slack_aliases": [
                {}
              ],
              "created_at": "<string>",
              "updated_at": "<string>"
            }
          }
        },
        "environments": [
          {
            "data": {
              "id": "<string>",
              "type": "environments",
              "attributes": {
                "name": "<string>",
                "slug": "<string>",
                "description": "<string>",
                "notify_emails": [
                  "<any>"
                ],
                "color": "<string>",
                "position": 123,
                "slack_channels": [
                  "<any>"
                ],
                "slack_aliases": [
                  "<any>"
                ],
                "created_at": "<string>",
                "updated_at": "<string>"
              }
            }
          }
        ],
        "incident_types": [
          {
            "data": {
              "id": "<string>",
              "type": "incident_types",
              "attributes": {
                "name": "<string>",
                "slug": "<string>",
                "description": "<string>",
                "color": "<string>",
                "position": 123,
                "notify_emails": [
                  "<any>"
                ],
                "slack_channels": [
                  "<any>"
                ],
                "slack_aliases": [
                  "<any>"
                ],
                "created_at": "<string>",
                "updated_at": "<string>"
              }
            }
          }
        ],
        "services": [
          {
            "data": {
              "id": "<string>",
              "type": "services",
              "attributes": {
                "name": "<string>",
                "slug": "<string>",
                "description": "<string>",
                "public_description": "<string>",
                "notify_emails": [
                  "<any>"
                ],
                "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>",
                "environment_ids": [
                  "<any>"
                ],
                "service_ids": [
                  "<any>"
                ],
                "owner_group_ids": [
                  "<any>"
                ],
                "owner_user_ids": [
                  "<any>"
                ],
                "alert_urgency_id": "<string>",
                "alerts_email_enabled": true,
                "alerts_email_address": "<string>",
                "slack_channels": [
                  "<any>"
                ],
                "slack_aliases": [
                  "<any>"
                ],
                "alert_broadcast_enabled": true,
                "alert_broadcast_channel": {},
                "incident_broadcast_enabled": true,
                "incident_broadcast_channel": {},
                "created_at": "<string>",
                "updated_at": "<string>"
              }
            }
          }
        ],
        "functionalities": [
          {
            "data": {
              "id": "<string>",
              "type": "functionalities",
              "attributes": {
                "name": "<string>",
                "slug": "<string>",
                "description": "<string>",
                "public_description": "<string>",
                "notify_emails": [
                  "<any>"
                ],
                "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": [
                  "<any>"
                ],
                "service_ids": [
                  "<any>"
                ],
                "owner_group_ids": [
                  "<any>"
                ],
                "owner_user_ids": [
                  "<any>"
                ],
                "slack_channels": [
                  "<any>"
                ],
                "slack_aliases": [
                  "<any>"
                ],
                "created_at": "<string>",
                "updated_at": "<string>"
              }
            }
          }
        ],
        "groups": [
          {
            "data": {
              "id": "<string>",
              "type": "groups",
              "attributes": {
                "name": "<string>",
                "slug": "<string>",
                "description": "<string>",
                "notify_emails": [
                  "<any>"
                ],
                "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": [
                  "<any>"
                ],
                "admin_ids": [
                  "<any>"
                ],
                "alerts_email_enabled": true,
                "alerts_email_address": "<string>",
                "alert_urgency_id": "<string>",
                "slack_channels": [
                  "<any>"
                ],
                "slack_aliases": [
                  "<any>"
                ],
                "alert_broadcast_enabled": true,
                "alert_broadcast_channel": {},
                "incident_broadcast_enabled": true,
                "incident_broadcast_channel": {},
                "auto_add_members_when_attached": true,
                "created_at": "<string>",
                "updated_at": "<string>"
              }
            }
          }
        ],
        "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": [
          "<string>"
        ],
        "google_drive_id": "<string>",
        "google_drive_parent_id": "<string>",
        "google_drive_url": "<string>",
        "google_meeting_id": "<string>",
        "google_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>",
        "retrospective_progress_status": "not_started",
        "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>",
        "created_at": "<string>",
        "updated_at": "<string>"
      }
    }
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "prev": "<string>",
    "next": "<string>",
    "last": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
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[services]
string
​
filter[service_ids]
string
​
filter[teams]
string
​
filter[team_ids]
string
​
filter[cause]
string
​
filter[cause_ids]
string
​
filter[custom_field_selected_option_ids]
string
​
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
​
sort
enum<string>

comma separated if needed. eg: created_at,updated_at

Available options:
created_at,
-created_at,
updated_at,
-updated_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

Response

200 - application/vnd.api+json

success

​
data
object[]
required
​
links
object
required
⌘I