v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
Incidents

List incident notification rules

Lists all notification rules for the organization. Optionally filter by incident type.

get/api/v2/incidents/config/notification-rules

Query parameters

includestring
Example:created_by_user,incident_type,notification_template

Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, incident_type, notification_template

Response

OK

Example response

{
  "data": [
    {
      "attributes": {
        "conditions": [
          {
            "field": "severity",
            "values": [
              "SEV-1",
              "SEV-2"
            ]
          }
        ],
        "created": "2025-01-15T10:30:00Z",
        "enabled": true,
        "handles": [
          "@team-email@company.com",
          "@slack-channel"
        ],
        "modified": "2025-01-15T14:45:00Z",
        "renotify_on": [
          "status",
          "severity"
        ],
        "trigger": "incident_created_trigger",
        "visibility": "organization"
      },
      "id": "00000000-0000-0000-0000-000000000001",
      "relationships": {
        "created_by_user": {
          "data": {
            "id": "00000000-0000-0000-2345-000000000000",
            "type": "users"
          }
        },
        "incident_type": {
          "data": {
            "id": "00000000-0000-0000-0000-000000000000",
            "type": "incident_types"
          }
        },
        "last_modified_by_user": {
          "data": {
            "id": "00000000-0000-0000-2345-000000000000",
            "type": "users"
          }
        },
        "notification_template": {
          "data": {
            "id": "00000000-0000-0000-0000-000000000001",
            "type": "notification_templates"
          }
        }
      },
      "type": "incident_notification_rules"
    }
  ],
  "included": [
    {
      "relationships": {
        "org": {
          "data": {
            "id": "00000000-0000-beef-0000-000000000000",
            "type": "orgs"
          }
        },
        "other_orgs": {
          "data": []
        },
        "other_users": {
          "data": []
        },
        "roles": {
          "data": [
            {
              "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d",
              "type": "roles"
            }
          ]
        }
      },
      "type": "users"
    }
  ],
  "meta": {
    "pagination": {
      "next_offset": 15,
      "size": 15
    }
  }
}