Check permissions
Check whether the given users can currently acknowledge, decline, or snooze an escalation.
This is a read-only projection of the escalationβs current state, intended for deciding which response actions to surface to each user in a custom integration.
To use this API, you will need an API key that can view escalations and users.
POST
/
v2
/
escalations
/
{escalation_id}
/
actions
/
check_permissions
Check permissions
curl --request POST \
--url https://api.incident.io/v2/escalations/{escalation_id}/actions/check_permissions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"user_ids": [
"01G0J1EXE7AXZ2C93K61WBPYEH"
]
}
'import requests
url = "https://api.incident.io/v2/escalations/{escalation_id}/actions/check_permissions"
payload = { "user_ids": ["01G0J1EXE7AXZ2C93K61WBPYEH"] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({user_ids: ['01G0J1EXE7AXZ2C93K61WBPYEH']})
};
fetch('https://api.incident.io/v2/escalations/{escalation_id}/actions/check_permissions', 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/escalations/{escalation_id}/actions/check_permissions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'user_ids' => [
'01G0J1EXE7AXZ2C93K61WBPYEH'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.incident.io/v2/escalations/{escalation_id}/actions/check_permissions"
payload := strings.NewReader("{\n \"user_ids\": [\n \"01G0J1EXE7AXZ2C93K61WBPYEH\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.incident.io/v2/escalations/{escalation_id}/actions/check_permissions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"user_ids\": [\n \"01G0J1EXE7AXZ2C93K61WBPYEH\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.incident.io/v2/escalations/{escalation_id}/actions/check_permissions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user_ids\": [\n \"01G0J1EXE7AXZ2C93K61WBPYEH\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"response_options": [
{
"available_actions": [
"ack",
"nack",
"snooze"
],
"user_id": "01G0J1EXE7AXZ2C93K61WBPYEH"
}
]
}π Requires the
escalations.view and users.view scopes.Authorizations
API key from your incident.io dashboard (Settings β API keys)
Path Parameters
The ID of the escalation
Example:
"01G0J1EXE7AXZ2C93K61WBPYEH"
Body
application/json
The IDs of the users to check response options for
Example:
["01G0J1EXE7AXZ2C93K61WBPYEH"]
Response
200 - application/json
OK response.
The response options available to each requested user, in the same order as the request.
Show child attributes
Show child attributes
Example:
[
{
"available_actions": ["ack", "nack", "snooze"],
"user_id": "01G0J1EXE7AXZ2C93K61WBPYEH"
}
]
Was this page helpful?
Check permissions
curl --request POST \
--url https://api.incident.io/v2/escalations/{escalation_id}/actions/check_permissions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"user_ids": [
"01G0J1EXE7AXZ2C93K61WBPYEH"
]
}
'import requests
url = "https://api.incident.io/v2/escalations/{escalation_id}/actions/check_permissions"
payload = { "user_ids": ["01G0J1EXE7AXZ2C93K61WBPYEH"] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({user_ids: ['01G0J1EXE7AXZ2C93K61WBPYEH']})
};
fetch('https://api.incident.io/v2/escalations/{escalation_id}/actions/check_permissions', 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/escalations/{escalation_id}/actions/check_permissions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'user_ids' => [
'01G0J1EXE7AXZ2C93K61WBPYEH'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.incident.io/v2/escalations/{escalation_id}/actions/check_permissions"
payload := strings.NewReader("{\n \"user_ids\": [\n \"01G0J1EXE7AXZ2C93K61WBPYEH\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.incident.io/v2/escalations/{escalation_id}/actions/check_permissions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"user_ids\": [\n \"01G0J1EXE7AXZ2C93K61WBPYEH\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.incident.io/v2/escalations/{escalation_id}/actions/check_permissions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user_ids\": [\n \"01G0J1EXE7AXZ2C93K61WBPYEH\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"response_options": [
{
"available_actions": [
"ack",
"nack",
"snooze"
],
"user_id": "01G0J1EXE7AXZ2C93K61WBPYEH"
}
]
}