--- title: Get On-Call escalation policy description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > On-Call --- {% callout %} # Important note for users on the following Datadog sites: app.ddog-gov.com, us2.ddog-gov.com {% alert level="danger" %} This product is not supported for your selected [Datadog site](https://docs.datadoghq.com/getting_started/site.md). ({% placeholder "user-datadog-site-name" /%}). {% /alert %} {% /callout %} # Get On-Call escalation policy{% #get-on-call-escalation-policy %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | -------------------------------------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/on-call/escalation-policies/{policy_id} | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/on-call/escalation-policies/{policy_id} | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/on-call/escalation-policies/{policy_id} | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/on-call/escalation-policies/{policy_id} | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/on-call/escalation-policies/{policy_id} | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/on-call/escalation-policies/{policy_id} | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/on-call/escalation-policies/{policy_id} | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/on-call/escalation-policies/{policy_id} | ### Overview Get an On-Call escalation policy This endpoint requires the `on_call_read` permission. ### Arguments #### Path Parameters | Name | Type | Description | | --------------------------- | ------ | ------------------------------- | | policy_id [*required*] | string | The ID of the escalation policy | #### Query Strings | Name | Type | Description | | ------- | ------ | ----------------------------------------------------------------------------------------------------------------- | | include | string | Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`. | ### Response {% tab title="200" %} OK {% tab title="Model" %} Represents a complete escalation policy response, including policy data and optionally included related resources. | Parent field | Field | Type | Description | | ------------- | ------------------------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data | object | Represents the data for a single escalation policy, including its attributes, ID, relationships, and resource type. | | data | attributes | object | Defines the main attributes of an escalation policy, such as its name and behavior on policy end. | | attributes | name [*required*] | string | Specifies the name of the escalation policy. | | attributes | resolve_page_on_policy_end | boolean | Indicates whether the page is automatically resolved when the policy ends. | | attributes | retries | int64 | Specifies how many times the escalation sequence is retried if there is no response. | | data | id | string | Specifies the unique identifier of the escalation policy. | | data | relationships | object | Represents the relationships for an escalation policy, including references to steps and teams. | | relationships | steps [*required*] | object | Defines the relationship to a collection of steps within an escalation policy. Contains an array of step data references. | | steps | data | [object] | An array of references to the steps defined in this escalation policy. | | data | id [*required*] | string | Specifies the unique identifier for the step resource. | | data | type [*required*] | enum | Indicates that the resource is of type `steps`. Allowed enum values: `steps` | | relationships | teams | object | Associates teams with this schedule in a data structure. | | teams | data | [object] | An array of team references for this schedule. | | data | id [*required*] | string | The unique identifier of the team in this relationship. | | data | type [*required*] | enum | Teams resource type. Allowed enum values: `teams` | | data | type [*required*] | enum | Indicates that the resource is of type `policies`. Allowed enum values: `policies` | | | included | [ ] | Provides any included related resources, such as steps or targets, returned with the policy. | | included | Option 1 | object | Represents a single step in an escalation policy, including its attributes, relationships, and resource type. | | Option 1 | attributes | object | Defines attributes for an escalation policy step, such as assignment strategy and escalation timeout. | | attributes | assignment | enum | Specifies how this escalation step will assign targets (example `default` or `round-robin`). Allowed enum values: `default,round-robin` | | attributes | escalate_after_seconds | int64 | Specifies how many seconds to wait before escalating to the next step. | | Option 1 | id | string | Specifies the unique identifier of this escalation policy step. | | Option 1 | relationships | object | Represents the relationship of an escalation policy step to its targets. | | relationships | targets | object | A list of escalation targets for a step | | targets | data | [ ] | The `EscalationTargets` `data`. | | data | Option 1 | object | Represents a team target for an escalation policy step, including the team's ID and resource type. | | Option 1 | id [*required*] | string | Specifies the unique identifier of the team resource. | | Option 1 | type [*required*] | enum | Indicates that the resource is of type `teams`. Allowed enum values: `teams` | | data | Option 2 | object | Represents a user target for an escalation policy step, including the user's ID and resource type. | | Option 2 | id [*required*] | string | Specifies the unique identifier of the user resource. | | Option 2 | type [*required*] | enum | Indicates that the resource is of type `users`. Allowed enum values: `users` | | data | Option 3 | object | Represents a schedule target for an escalation policy step, including its ID and resource type. This is a shortcut for a configured schedule target with position set to 'current'. | | Option 3 | id [*required*] | string | Specifies the unique identifier of the schedule resource. | | Option 3 | type [*required*] | enum | Indicates that the resource is of type `schedules`. Allowed enum values: `schedules` | | data | Option 4 | object | Relationship reference to a configured schedule target. | | Option 4 | id [*required*] | string | Specifies the unique identifier of the configured schedule target. | | Option 4 | type [*required*] | enum | Indicates that the resource is of type `schedule_target`. Allowed enum values: `schedule_target` | | Option 1 | type [*required*] | enum | Indicates that the resource is of type `steps`. Allowed enum values: `steps` | | included | Option 2 | object | Represents a user object in the context of an escalation policy, including their `id`, type, and basic attributes. | | Option 2 | attributes | object | Provides basic user information for an escalation policy, including a name and email address. | | attributes | email | string | The user's email address. | | attributes | name | string | The user's name. | | attributes | status | enum | The user's status. Allowed enum values: `active,deactivated,pending` | | Option 2 | id | string | The unique user identifier. | | Option 2 | type [*required*] | enum | Users resource type. Allowed enum values: `users` | | included | Option 3 | object | Represents the primary data object for a schedule, linking attributes and relationships. | | Option 3 | attributes | object | Provides core properties of a schedule object such as its name and time zone. | | attributes | name | string | A short name for the schedule. | | attributes | time_zone | string | The time zone in which this schedule operates. | | Option 3 | id | string | The schedule's unique identifier. | | Option 3 | relationships | object | Groups the relationships for a schedule object, referencing layers and teams. | | relationships | layers | object | Associates layers with this schedule in a data structure. | | layers | data | [object] | An array of layer references for this schedule. | | data | id [*required*] | string | The unique identifier of the layer in this relationship. | | data | type [*required*] | enum | Layers resource type. Allowed enum values: `layers` | | relationships | teams | object | Associates teams with this schedule in a data structure. | | teams | data | [object] | An array of team references for this schedule. | | data | id [*required*] | string | The unique identifier of the team in this relationship. | | data | type [*required*] | enum | Teams resource type. Allowed enum values: `teams` | | Option 3 | type [*required*] | enum | Schedules resource type. Allowed enum values: `schedules` | | included | Option 4 | object | Full resource representation of a configured schedule target with position (previous, current, or next). | | Option 4 | attributes [*required*] | object | Attributes for a configured schedule target, including position. | | attributes | position [*required*] | enum | Specifies the position of a schedule target (example `previous`, `current`, or `next`). Allowed enum values: `previous,current,next` | | Option 4 | id [*required*] | string | Specifies the unique identifier of the configured schedule target. | | Option 4 | relationships [*required*] | object | Represents the relationships of a configured schedule target. | | relationships | schedule [*required*] | object | Holds the schedule reference for a configured schedule target. | | schedule | data [*required*] | object | Represents a schedule target for an escalation policy step, including its ID and resource type. This is a shortcut for a configured schedule target with position set to 'current'. | | data | id [*required*] | string | Specifies the unique identifier of the schedule resource. | | data | type [*required*] | enum | Indicates that the resource is of type `schedules`. Allowed enum values: `schedules` | | Option 4 | type [*required*] | enum | Indicates that the resource is of type `schedule_target`. Allowed enum values: `schedule_target` | | included | Option 5 | object | Provides a reference to a team, including ID, type, and basic attributes/relationships. | | Option 5 | attributes | object | Encapsulates the basic attributes of a Team reference, such as name, handle, and an optional avatar or description. | | attributes | avatar | string | URL or reference for the team's avatar (if available). | | attributes | description | string | A short text describing the team. | | attributes | handle | string | A unique handle/slug for the team. | | attributes | name | string | The full, human-readable name of the team. | | Option 5 | id | string | The team's unique identifier. | | Option 5 | type [*required*] | enum | Teams resource type. Allowed enum values: `teams` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "name": "Escalation Policy 1", "resolve_page_on_policy_end": true, "retries": 2 }, "id": "00000000-aba1-0000-0000-000000000000", "relationships": { "steps": { "data": [ { "id": "00000000-aba1-0000-0000-000000000000", "type": "steps" } ] }, "teams": { "data": [ { "id": "00000000-da3a-0000-0000-000000000000", "type": "teams" } ] } }, "type": "policies" }, "included": [ { "attributes": { "avatar": "", "description": "Team 1 description", "handle": "team1", "name": "Team 1" }, "id": "00000000-da3a-0000-0000-000000000000", "type": "teams" }, { "attributes": { "assignment": "default", "escalate_after_seconds": 3600 }, "id": "00000000-aba1-0000-0000-000000000000", "relationships": { "targets": { "data": [ { "id": "00000000-aba1-0000-0000-000000000000", "type": "users" }, { "id": "00000000-aba2-0000-0000-000000000000", "type": "schedules" }, { "id": "00000000-aba2-0000-0000-000000000000_previous", "type": "schedule_target" }, { "id": "00000000-aba3-0000-0000-000000000000", "type": "teams" } ] } }, "type": "steps" }, { "id": "00000000-aba1-0000-0000-000000000000", "type": "users" }, { "id": "00000000-aba2-0000-0000-000000000000", "type": "schedules" }, { "attributes": { "position": "previous" }, "id": "00000000-aba2-0000-0000-000000000000_previous", "relationships": { "schedule": { "data": { "id": "00000000-aba2-0000-0000-000000000000", "type": "schedules" } } }, "type": "schedule_target" }, { "id": "00000000-aba3-0000-0000-000000000000", "type": "teams" } ] } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="401" %} Unauthorized {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Not Found {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Path parameters export policy_id="a3000000-0000-0000-0000-000000000000" \# Curl command curl -X GET "https://api.datadoghq.com/api/v2/on-call/escalation-policies/${policy_id}" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ Get On-Call escalation policy returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.on_call_api import OnCallApi # there is a valid "escalation_policy" in the system ESCALATION_POLICY_DATA_ID = environ["ESCALATION_POLICY_DATA_ID"] configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = OnCallApi(api_client) response = api_instance.get_on_call_escalation_policy( policy_id=ESCALATION_POLICY_DATA_ID, include="steps.targets", ) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Get On-Call escalation policy returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::OnCallAPI.new # there is a valid "escalation_policy" in the system ESCALATION_POLICY_DATA_ID = ENV["ESCALATION_POLICY_DATA_ID"] opts = { include: "steps.targets", } p api_instance.get_on_call_escalation_policy(ESCALATION_POLICY_DATA_ID, opts) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Get On-Call escalation policy returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { // there is a valid "escalation_policy" in the system EscalationPolicyDataID := os.Getenv("ESCALATION_POLICY_DATA_ID") ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewOnCallApi(apiClient) resp, r, err := api.GetOnCallEscalationPolicy(ctx, EscalationPolicyDataID, *datadogV2.NewGetOnCallEscalationPolicyOptionalParameters().WithInclude("steps.targets")) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `OnCallApi.GetOnCallEscalationPolicy`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `OnCallApi.GetOnCallEscalationPolicy`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Get On-Call escalation policy returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.OnCallApi; import com.datadog.api.client.v2.api.OnCallApi.GetOnCallEscalationPolicyOptionalParameters; import com.datadog.api.client.v2.model.EscalationPolicy; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); OnCallApi apiInstance = new OnCallApi(defaultClient); // there is a valid "escalation_policy" in the system String ESCALATION_POLICY_DATA_ID = System.getenv("ESCALATION_POLICY_DATA_ID"); try { EscalationPolicy result = apiInstance.getOnCallEscalationPolicy( ESCALATION_POLICY_DATA_ID, new GetOnCallEscalationPolicyOptionalParameters().include("steps.targets")); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling OnCallApi#getOnCallEscalationPolicy"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Get On-Call escalation policy returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_on_call::GetOnCallEscalationPolicyOptionalParams; use datadog_api_client::datadogV2::api_on_call::OnCallAPI; #[tokio::main] async fn main() { // there is a valid "escalation_policy" in the system let escalation_policy_data_id = std::env::var("ESCALATION_POLICY_DATA_ID").unwrap(); let configuration = datadog::Configuration::new(); let api = OnCallAPI::with_config(configuration); let resp = api .get_on_call_escalation_policy( escalation_policy_data_id.clone(), GetOnCallEscalationPolicyOptionalParams::default().include("steps.targets".to_string()), ) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Get On-Call escalation policy returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.OnCallApi(configuration); // there is a valid "escalation_policy" in the system const ESCALATION_POLICY_DATA_ID = process.env .ESCALATION_POLICY_DATA_ID as string; const params: v2.OnCallApiGetOnCallEscalationPolicyRequest = { policyId: ESCALATION_POLICY_DATA_ID, include: "steps.targets", }; apiInstance .getOnCallEscalationPolicy(params) .then((data: v2.EscalationPolicy) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}