Templates

List alert templates

Retrieves a list of all alert notification templates configured for an organization. Returns template names, types, and basic metadata to help administrators manage notification formatting options. Templates provide reusable formatting configurations that ensure consistent alert notifications across different channels and destinations.

get/api/{org_id}/alerts/templates

Request

Path parameters

org_idstring required

Organization name

Query parameters

applies_tostring nullable
typestring nullable

Response

Success

applies_tostring[] nullable

Kinds the template is meant for; [] is every kind. Absent on update keeps the stored list.

bodystring
isDefaultboolean nullable
isPrebuiltboolean

True for system-managed prebuilt templates (those whose name starts with prebuilt_). The public API refuses updates and deletes for these, so the UI should render them as read-only.

kindstring nullable

Template kind: "custom" (default) or "content". Absent on write means "unspecified" — create defaults to custom, update preserves the stored kind (sticky-kind rule, design §6.2).

namestring
titlestring
type'http' | 'email' | 'sns' | 'slack_app'

Changes

No recorded changes to this operation across all 1 revision of this API.