v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

On-Call

List On-Call notification rules for a user

List the notification rules for a user. The authenticated user must be the target user or have the on_call_admin permission

get/api/v2/on-call/users/{user_id}/notification-rules

Path parameters

user_idstring required

Example:00000000-0000-0000-0000-000000000000

The user ID

Query parameters

includestring

Comma-separated list of included relationships to be returned. Allowed values: channel.

Response

Example response

{
  "data": [
    {
      "attributes": {
        "channel_settings": {
          "method": "sms",
          "type": "phone"
        }
      },
      "relationships": {
        "channel": {
          "data": {
            "type": "notification_channels"
          }
        }
      },
      "type": "notification_rules"
    }
  ],
  "included": [
    {
      "attributes": {
        "config": {
          "type": "phone"
        }
      },
      "type": "notification_channels"
    }
  ]
}