Retrieves an alert group

{ "data": { "id": "5ba843bd-2e52-4be0-98c2-7876349af0ea", "type": "alert_groups", "attributes": { "name": "123 test group", "slug": "123-test-group", "description": null, "time_window": 10, "condition_type": "any", "deleted_at": null, "created_at": "2025-12-09T22:48:49.947-08:00", "updated_at": "2025-12-09T22:48:49.947-08:00", "group_by_alert_title": false, "group_by_alert_urgency": false, "targets": [ { "id": "8e5da81b-e983-494b-b7d2-16e63339ee60", "alert_group_id": "5ba843bd-2e52-4be0-98c2-7876349af0ea", "created_at": "2025-12-09T22:48:49.951-08:00", "deleted_at": null, "target_id": "02de4842-ddad-45a8-bf3b-37ff4a41a9a4", "target_type": "Service", "updated_at": "2025-12-09T22:48:49.951-08:00" } ], "attributes": [] } } }

Authorizations

Authorization

string

header

required

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

Path Parameters

required

Resource UUID

Response

alert_group found by slug

data

object

required

Show child attributes

data.id

string

required

Unique ID of the alert group

data.type

enum<string>

required

Available options:

alert_groups

data.attributes

object

required

Show child attributes

data.attributes.name

string

required

The name of the alert group

data.attributes.description

string | null

required

The description of the alert group

data.attributes.slug

string

required

The slug of the alert group

data.attributes.condition_type

string

required

Grouping condition for the alert group

data.attributes.time_window

integer

required

Time window for the alert grouping

data.attributes.created_at

string

required

Date of creation

data.attributes.updated_at

string

required

Date of last update

data.attributes.deleted_at

string | null

required

Date or deletion

data.attributes.group_by_alert_title

boolean

Whether the alerts are grouped by title or not

data.attributes.group_by_alert_urgency

boolean

Whether the alerts are grouped by urgency or not

data.attributes.targets

object[]

Show child attributes

data.attributes.targets.target_type

enum<string>

required

The type of the target.

Available options:

Group,

Service,

EscalationPolicy

data.attributes.targets.target_id

string<uuid>

required

id for the Group, Service or EscalationPolicy

data.attributes.attributes

object[]

deprecated

This field is deprecated. Please use the conditions field instead, attributes will be removed in the future.

Show child attributes

data.attributes.attributes.json_path

string

The JSON path to the value to group by.

data.attributes.conditions

object[]

The conditions for the alert group

Show child attributes

data.attributes.conditions.property_field_type

enum<string>

required

The type of the property field

Available options:

attribute,

payload,

alert_field

data.attributes.conditions.property_field_condition_type

enum<string>

required

The condition type of the property field

Available options:

is_one_of,

is_not_one_of,

contains,

does_not_contain,

starts_with,

ends_with,

matches_regex,

is_empty,

matches_existing_alert

data.attributes.conditions.property_field_name

string | null

The name of the property field. If the property field type is selected as 'attribute', then the allowed property field names are 'summary' (for Title), 'description', 'alert_urgency' and 'external_url' (for Alert Source URL). If the property field type is selected as 'payload', then the property field name should be supplied in JSON Path syntax.

data.attributes.conditions.property_field_value

string | null

The value of the property field. Can be null if the property field condition type is 'is_one_of' or 'is_not_one_of'

data.attributes.conditions.property_field_values

string[]

The values of the property field. Used if the property field condition type is 'is_one_of' or 'is_not_one_of' except for when property field name is 'alert_urgency'

data.attributes.conditions.values

(object | null)[]

Show child attributes

data.attributes.conditions.values.record_id

string

required

ID of the Alert Urgency to set.

data.attributes.conditions.values.record_type

string

required

Should be "AlertUrgency".

data.attributes.conditions.alert_urgency_ids

string[] | null

The Alert Urgency ID's to check in the condition. Only need to be set when the property field type is 'attribute', the property field name is 'alert_urgency' and the property field condition type is 'is_one_of' or 'is_not_one_of'

data.attributes.conditions.conditionable_type

enum<string> | null

The type of the conditionable

Available options:

AlertField

data.attributes.conditions.conditionable_id

string | null

The ID of the conditionable. If conditionable_type is AlertField, this is the ID of the alert field.

Overview

AlertEvents

AlertFields

AlertGroups

AlertRoutes

AlertRoutingRules

AlertUrgencies

AlertSources

Alerts

Audits

Authorizations

CatalogEntities

CatalogEntityProperties

CatalogFields

Catalogs

Causes

Communications Groups

Communications Stages

Communications Templates

Communications Types

[DEPRECATED] CustomFieldOptions

[DEPRECATED] CustomFields

CustomForms

DashboardPanels

Dashboards

Environments

EscalationPolicies

EscalationLevelsPolicies

EscalationLevelsPath

EscalationLevels

EscalationPaths

FormFieldOptions

FormFieldPlacementConditions

FormFieldPlacements

FormFieldPositions

FormFields

FormSetConditions

FormSets

Functionalities

WorkflowTasks

[DEPRECATED] WorkflowCustomFieldSelections

WorkflowFormFieldConditions

WorkflowGroups

WorkflowRuns

Workflows

Heartbeats

IncidentActionItems

[DEPRECATED] IncidentCustomFieldSelections

IncidentEventFunctionalities

IncidentEventServices

IncidentEvents

IncidentFeedbacks

IncidentFormFieldSelections

IncidentPermissionSetBooleans

IncidentPermissionSetResources

IncidentPermissionSets

IncidentRetrospectives

IncidentRetrospectiveSteps

IncidentRoleTasks

IncidentRoles

IncidentStatusPageEvents

IncidentSubStatuses

IncidentTypes

Incidents

IpRanges

LiveCallRouters

OnCallRoles

OnCallShadows

OverrideShifts

PlaybookTasks

Playbooks

RetrospectiveTemplates

Pulses

RetrospectiveConfigurations

RetrospectiveProcessGroupSteps

RetrospectiveProcessGroups

RetrospectiveProcesses

RetrospectiveSteps

Roles

ScheduleRotationActiveDays