v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

On-Call

Get an On-Call notification rule for a user

Get a notification rule 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/{rule_id}

Path parameters

user_idstring required

Example:00000000-0000-0000-0000-000000000000

The user ID

rule_idstring required

Example:00000000-0000-0000-0000-000000000000

The rule ID

Query parameters

includestring

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

Response

Example response

{
  "data": {
    "attributes": {
      "category": "high_urgency",
      "channel_settings": {
        "method": "sms",
        "type": "phone"
      },
      "delay_minutes": 1
    },
    "id": "27590dae-47be-4a7d-9abf-8f4e45124020",
    "relationships": {
      "channel": {
        "data": {
          "id": "1562fab3-a8c2-49e2-8f3a-28dcda2405e2",
          "type": "notification_channels"
        }
      }
    },
    "type": "notification_rules"
  }
}