Get an escalation policy by ID.

GET

/escalation_policy/{policy_id}

const url = 'https://api.siteqwality.com/escalation_policy/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.siteqwality.com/escalation_policy/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer_auth

Parameters

Path Parameters

policy_id

required

string format: uuid

Escalation policy identifier

Responses

200

Escalation policy

application/json

object

required

string format: uuid

account_id

required

string format: uuid

name

required

string

repeat_count

required

Times to run through every level again after the first pass.

integer format: int32

created_at

required

string format: date-time

levels

array | null

object

required

string format: uuid

escalation_policy_id

required

string format: uuid

level_number

required

integer format: int32

timeout_minutes

required

integer format: int32

target_user_ids

required

Array<string>

target_schedule_ids

required

Array<string>

created_at

required

string format: date-time

on_exhausted

What happens when the repeats are used up, or no level reaches anyone.

string

Allowed values: notify_owners stop escalate_to_policy

escalate_to_policy_id

The policy escalate_to_policy runs once; null otherwise.

string | null format: uuid

Example

{
  "on_exhausted": "notify_owners"
}

401

Missing or invalid authentication

404

Policy not found

500

Internal server error