v1

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

List incident notification templates

Lists all notification templates. Optionally filter by incident type.

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

Query parameters

filter[incident-type]string uuid
Example:00000000-0000-0000-0000-000000000001

Optional incident type ID filter.

includestring
Example:created_by_user,incident_type

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

Response

OK

Example response

{
  "data": [
    {
      "attributes": {
        "category": "alert",
        "content": "An incident has been declared.\n\nTitle: {{incident.title}}\nSeverity: {{incident.severity}}\nAffected Services: {{incident.services}}\nStatus: {{incident.state}}\n\nPlease join the incident channel for updates.",
        "created": "2025-01-15T10:30:00Z",
        "modified": "2025-01-15T14:45:00Z",
        "name": "Incident Alert Template",
        "subject": "{{incident.severity}} Incident: {{incident.title}}"
      },
      "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"
          }
        }
      },
      "type": "notification_templates"
    }
  ],
  "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": {
    "page": {
      "total_count": 42,
      "total_filtered_count": 15
    }
  }
}