--- title: List On-Call escalation policies description: Retrieve a paginated list of On-Call escalation policies, sorted by name. breadcrumbs: Documentación > API > List On-Call escalation policies --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/llms.txt). # List On-Call escalation policies {% callout %} This product or feature is not supported for the following sites: us2.ddog-gov.com {% /callout %} ## v2 (latest) | Datadog site | API endpoint | | ----------------- | -------------------------------------------------------------------- | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/on-call/escalation-policies | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/on-call/escalation-policies | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/on-call/escalation-policies | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/on-call/escalation-policies | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/on-call/escalation-policies | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/on-call/escalation-policies | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/on-call/escalation-policies | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/on-call/escalation-policies | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/on-call/escalation-policies | ### Overview Retrieve a paginated list of On-Call escalation policies, sorted by name. This endpoint requires the `on_call_read` permission. ### Arguments #### Query Strings | Field | Type | Description | | ------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | page[size] | integer | Number of escalation policies to return per page. The maximum allowed value is 50. Default: `20`. | | page[number] | integer | Specific page number to return. Default: `0`. | | filter[query] | string | Search query to filter escalation policies. Supports free-text search on the policy name (case-insensitive) and structured filters on `team.id` and `tags`. When set, `filter[team_id]`, `filter[user_id]`, and `filter[schedule_id]` are ignored. Can't be combined with `filter[tags]` or `filter[tags_any]`. | | filter[team_id] | string | Comma-separated list of team IDs. Returns escalation policies that belong to any of these teams or have a step targeting any of them. | | filter[user_id] | string | Comma-separated list of user IDs. Returns escalation policies with a step targeting any of these users. | | filter[schedule_id] | string | Comma-separated list of schedule IDs. Returns escalation policies with a step targeting any of these schedules. | | filter[tags] | string | Comma-separated list of `key:value` tags. Returns escalation policies that have all of these tags. | | filter[tags_any] | string | Comma-separated list of `key:value` tags. Returns escalation policies that have at least one of these tags. | | include | string | Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`, `steps.targets.schedule`, `user.color`. `user.color` populates the `color` attribute of users included through `steps.targets`. | ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} A paginated list of escalation policies, with any related resources requested through `include`. | Parent field | Field | Type | Description | | ---------------------- | -------------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | [object] | A list of escalation policies. | | 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. | | attributes | tags | [string] | A list of tags attached to the escalation policy, in `key:value` format. | | data | id [*required*] | 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`. Default: `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`. Default: `teams`. | | data | type [*required*] | enum | Indicates that the resource is of type `policies`. Allowed enum values: `policies`. Default: `policies`. | | | included | [] | Provides any included related resources, such as teams, steps, or targets, returned with the policies. | | included | | object | Represents a single step in an escalation policy, including its attributes, relationships, and resource type. | | | 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. | | | id | string | Specifies the unique identifier of this escalation policy step. | | | 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 | | object | Represents a team target for an escalation policy step, including the team's ID and resource type. | | | id [*required*] | string | Specifies the unique identifier of the team resource. | | | type [*required*] | enum | Indicates that the resource is of type `teams`. Allowed enum values: `teams`. Default: `teams`. | | data | | object | Represents a user target for an escalation policy step, including the user's ID and resource type. | | | id [*required*] | string | Specifies the unique identifier of the user resource. | | | type [*required*] | enum | Indicates that the resource is of type `users`. Allowed enum values: `users`. Default: `users`. | | data | | 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'. | | | id [*required*] | string | Specifies the unique identifier of the schedule resource. | | | type [*required*] | enum | Indicates that the resource is of type `schedules`. Allowed enum values: `schedules`. Default: `schedules`. | | data | | object | Relationship reference to a configured schedule target. | | | id [*required*] | string | Specifies the unique identifier of the configured schedule target. | | | type [*required*] | enum | Indicates that the resource is of type `schedule_target`. Allowed enum values: `schedule_target`. Default: `schedule_target`. | | | type [*required*] | enum | Indicates that the resource is of type `steps`. Allowed enum values: `steps`. Default: `steps`. | | included | | object | Represents a user object in the context of an escalation policy, including their `id`, type, and basic attributes. | | | attributes | object | Provides basic user information for an escalation policy, including a name and email address. | | attributes | color | string | The user's on-call color, as a hex code (for example, `#FF0000`). Included only when `user.color` is requested in the `include` parameter. | | 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`. | | | id | string | The unique user identifier. | | | type [*required*] | enum | Users resource type. Allowed enum values: `users`. Default: `users`. | | included | | object | Represents the primary data object for a schedule, linking attributes and relationships. | | | attributes | object | Provides core properties of a schedule object such as its name and time zone. | | attributes | max_responders | int64 | Maximum number of users who can be on call at the same time. The value is between 1 and the number of layers, and no greater than 10. | | attributes | name | string | A short name for the schedule. | | attributes | tags | [string] | A list of tags associated with the schedule. | | attributes | time_zone | string | The time zone in which this schedule operates. | | | id | string | The schedule's unique identifier. | | | 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`. Default: `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`. Default: `teams`. | | | type [*required*] | enum | Schedules resource type. Allowed enum values: `schedules`. Default: `schedules`. | | included | | object | Full resource representation of a configured schedule target with position (previous, current, or next). | | | 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`. | | | id [*required*] | string | Specifies the unique identifier of the configured schedule target. | | | 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`. Default: `schedules`. | | | type [*required*] | enum | Indicates that the resource is of type `schedule_target`. Allowed enum values: `schedule_target`. Default: `schedule_target`. | | included | | object | Provides a reference to a team, including ID, type, and basic attributes/relationships. | | | 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. | | | id | string | The team's unique identifier. | | | type [*required*] | enum | Teams resource type. Allowed enum values: `teams`. Default: `teams`. | | | meta | object | Metadata included in the response when listing escalation policies. | | meta | page | object | Pagination metadata included in the response when listing escalation policies. | | page | first_number | int64 | First page number. | | page | last_number | int64 | Last page number. | | page | next_number | int64 | Next page number. | | page | number | int64 | Page number. | | page | prev_number | int64 | Previous page number. | | page | size | int64 | Page size. | | page | total | int64 | Total number of results. | | page | type | string | Pagination type. | {% /tab %} {% tab label="Example" %} ```json { "data": [ { "attributes": { "name": "On-Call Escalation Policy", "resolve_page_on_policy_end": false, "retries": "integer", "tags": [ "env:prod" ] }, "id": "ab000000-0000-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": { "assignment": "string", "escalate_after_seconds": "integer" }, "id": "string", "relationships": { "targets": { "data": [ { "id": "00000000-aba1-0000-0000-000000000000", "type": "teams" } ] } }, "type": "steps" } ], "meta": { "page": { "first_number": "integer", "last_number": "integer", "next_number": "integer", "number": "integer", "prev_number": "integer", "size": "integer", "total": "integer", "type": "number_size" } } } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="400" %} Bad Request {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="401" %} Unauthorized {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="403" %} Forbidden {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" curl -X GET "https://api.${DD_SITE}/api/v2/on-call/escalation-policies" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ``` {% /tab %} {% /tabs %}