List

List notification rules for a user. Rules define how and when a user is notified for on-call pages. Only includes high_urgency and low_urgency rules; shift_changes rules are not returned.

GET /v2/users/{user_id}/notification_rules

List

cURL

curl --request GET \
  --url https://api.incident.io/v2/users/{user_id}/notification_rules \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.incident.io/v2/users/{user_id}/notification_rules"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.incident.io/v2/users/{user_id}/notification_rules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.incident.io/v2/users/{user_id}/notification_rules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.incident.io/v2/users/{user_id}/notification_rules"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.incident.io/v2/users/{user_id}/notification_rules")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.incident.io/v2/users/{user_id}/notification_rules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "notification_rules": [
    {
      "app": {
        "push_notification_criticality": "critical"
      },
      "delay_seconds": 0,
      "id": "01FCNDV6P870EA6S7TK1DSYDG0",
      "method_target": {
        "all": {},
        "specific": {
          "id": "01FCNDV6P870EA6S7TK1DSYDG0"
        },
        "type": "specific"
      },
      "method_type": "app",
      "phone": {
        "channel": "voice"
      },
      "rule_type": "low_urgency"
    }
  ]
}

🔑 Requires the notification_rules.view scope.

Authorizations

Authorization · string · header · required

API key from your incident.io dashboard (Settings → API keys)

Path Parameters

user_id · string · required

The ID of the user whose notification rules you want to list.

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

Response

200 - application/json

OK response.

notification_rules · object[] · required

Show child attributes

Example:

[
  {
    "app": {
      "push_notification_criticality": "critical"
    },
    "delay_seconds": 0,
    "id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "method_target": {
      "all": {},
      "specific": { "id": "01FCNDV6P870EA6S7TK1DSYDG0" },
      "type": "specific"
    },
    "method_type": "app",
    "phone": { "channel": "voice" },
    "rule_type": "low_urgency"
  }
]