Sign in
Alarms

List recipients

Retrieve all recipients for an instance that can receive notifications

get/alarms/recipients

Response

Successful response

idinteger

Recipient ID

type'email' | 'webhook' | 'pagerduty' | 'opsgenie' | 'opsgenie-eu' | 'victorops' | 'slack' | 'teams'

Recipient type

valuestring

Recipient endpoint (email, URL, etc.)

namestring

Recipient name

optionsobject nullable

Additional options

Example response

[
  {
    "id": 1,
    "type": "email",
    "value": "team@example.com",
    "name": "Default"
  }
]

Changes