--- title: "List On-Call Pages" method: GET path: "/api/v2/on-call/pages" tags: ["On-Call"] --- # List On-Call Pages `GET /api/v2/on-call/pages` ## Request - Base URL: `https://api.datadoghq.com` - URL: `https://api.datadoghq.com/api/v2/on-call/pages` - Auth: one of: - API key in header `DD-API-KEY` and API key in header `DD-APPLICATION-KEY` - OAuth 2 - Authorization code: `/oauth2/v1/authorize` - Token URL: `/oauth2/v1/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Retrieve a paginated list of On-Call Pages, optionally filtered by a search query and sorted by a field. ## Query parameters - `page[size]` integer - `page[number]` integer - `filter[query]` string - `sort` 'created_at' | '-created_at' | 'modified_at' | '-modified_at' | 'status' | '-status' | 'priority' | '-priority': Sorting options for Pages. Prefix a field with `-` to sort in descending order. ## Response `200` OK - OnCallPagesResponse: A list of On-Call Pages with pagination metadata and related included resources. - `data` OnCallPageData[], required: A list of Pages. - `attributes` OnCallPageDataAttributes: The attributes of an On-Call Page. - `acknowledged_at` string, date-time: The time when the Page was first acknowledged. - `closed_at` string, date-time: The time when the Page was resolved. - `comment_count` integer: The number of comments on the Page. - `created_at` string, date-time, required: The time when the Page was created. - `description` string, required: A short summary of the issue or context. - `escalation_policy_uuid` string, uuid: The ID of the escalation policy used to route the Page. - `key` string, required: An alternative numeric identifier of the Page, as displayed in the Datadog UI. - `live_call` OnCallPageLiveCall: Live call information for a Page triggered by a live call route. - `call_over` OnCallPageLiveCallOver: Information about a live call that has ended. - `outcome` 'success_call_answered' | 'failure_no_responder' | 'failure_caller_abandoned' | 'failure_outside_support_hours' | 'failure_internal_error': The outcome of a live call that has ended. - `support_hours_start_at` string, date-time: When support hours start, if the call was placed outside support hours. - `modified_at` string, date-time: The time when the Page was last modified. - `release_at` string, date-time: The time when the snooze ends. Only set while the Page is snoozed, together with `release_origin`. - `release_origin` 'ack_timeout' | 'team_rules_active_hours' | 'manual_snooze': What snoozed the Page. Only set while the Page is snoozed, together with `release_at`. `ack_timeout`: the acknowledgment timeout. `team_rules_active_hours`: the Page was triggered outside of the active hours of the team's routing rules. `manual_snooze`: a user snoozed the Page. - `responders_added_at` string, date-time: The time when responders were first added to the Page. - `services` string[]: The services associated with the Page. - `status` 'triggered' | 'acknowledged' | 'resolved', required: The current status of the On-Call Page. - `tags` string[], required: Tags associated with the Page. - `title` string, required: The title of the Page. - `urgency` 'low' | 'high', required: On-Call Page urgency level. - `id` string, uuid, required: The unique ID of the Page. - `relationships` OnCallPageDataRelationships: The relationships of an On-Call Page. - `author` OnCallPageAuthorRelationship: Reference to the entity that performed an action on the Page. - `data` OnCallPageAuthorRelationshipData, nullable: Reference to the author of a Page action. - `id` string, required: The ID of the author. - `type` string, required: The resource type of the author, for example `users`, `monitors`, `incident_authors`, or `security_signal`. - `closed_by` OnCallPageAuthorRelationship: Reference to the entity that performed an action on the Page. - `data` OnCallPageAuthorRelationshipData, nullable: Reference to the author of a Page action. - `id` string, required: The ID of the author. - `type` string, required: The resource type of the author, for example `users`, `monitors`, `incident_authors`, or `security_signal`. - `jira_issue` OnCallPageJiraIssueRelationship: The Jira issue linked to the Page. - `data` OnCallPageJiraIssueRelationshipData: Reference to a Jira issue. - `id` string, required: The ID of the Jira issue, in the form `:`. - `type` 'jira_issues', required: Jira issue resource type. - `links` OnCallPageLinksRelationship: Links between the Page and other Datadog resources, such as incidents. Always empty when listing Pages. - `data` OnCallPageLinkRelationshipData[]: The list of Page links. - `id` string, required: The ID of the link. - `type` 'links', required: Page link resource type. - `responders` OnCallPageRespondersRelationship: The users responding to the Page. - `data` OnCallPageUserRelationshipData[]: The list of responders. - `id` string, required: The user ID. - `type` 'users', required: Users resource type. - `scheduled_action` OnCallPageScheduledActionRelationship: The next action scheduled on the Page, such as an escalation. - `data` OnCallPageScheduledActionRelationshipData, nullable: Reference to the next scheduled action on the Page. - `id` string, required: The ID of the scheduled action. Equal to the Page ID. - `type` 'scheduled_actions', required: Scheduled action resource type. - `service_now_incident` OnCallPageServiceNowIncidentRelationship: The ServiceNow incident linked to the Page. - `data` OnCallPageServiceNowIncidentRelationshipData: Reference to a ServiceNow incident. - `id` string, required: The ID of the ServiceNow incident. - `type` 'service_now_incidents', required: ServiceNow incident resource type. - `target` OnCallPageTargetRelationship: The team, user, or cross-organization handle that was paged. - `data` OnCallPageTargetRelationshipData, nullable: Reference to the target of the Page. - `id` string, required: The ID of the target. - `type` 'teams' | 'users' | 'cross_org_handles', required: The resource type of the Page target. - `team_routing_rule` OnCallPageTeamRoutingRuleRelationship: The team routing rule that matched the Page. - `data` OnCallPageTeamRoutingRuleRelationshipData: Reference to a team routing rule. - `id` string, required: The ID of the team routing rule. - `type` 'team_routing_rules', required: Indicates that the resource is of type `team_routing_rules`. - `type` 'pages', required: Indicates that the resource is of type `pages`. - `included` OnCallPagesIncluded[]: Resources related to the Pages, such as users, teams, and scheduled actions. - union: A resource related to a Page. - ScheduleUser: Represents a user object in the context of a schedule, including their `id`, type, and basic attributes. - `attributes` ScheduleUserAttributes: Provides basic user information for a schedule, including a name and email address. - `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. - `email` string: The user's email address. - `name` string: The user's name. - `status` 'active' | 'deactivated' | 'pending': The user's status. - `id` string, required: The unique user identifier. - `type` 'users', required: Users resource type. - TeamReference: Provides a reference to a team, including ID, type, and basic attributes/relationships. - `attributes` TeamReferenceAttributes: Encapsulates the basic attributes of a Team reference, such as name, handle, and an optional avatar or description. - `avatar` string: URL or reference for the team's avatar (if available). - `description` string: A short text describing the team. - `handle` string: A unique handle/slug for the team. - `name` string: The full, human-readable name of the team. - `id` string: The team's unique identifier. - `type` 'teams', required: Teams resource type. - OnCallPageScheduledAction: The next action scheduled on a Page, such as an escalation or an automatic resolution. - `attributes` OnCallPageScheduledActionAttributes: The attributes of a scheduled action. - `at` string, date-time: The time when the action is scheduled to run. - `type` 'escalate' | 'resolve' | 'release' | 'retrigger': The kind of action that is scheduled. - `id` string, required: The ID of the scheduled action. Equal to the Page ID. - `relationships` OnCallPageScheduledActionRelationships: The relationships of a scheduled action. - `schedules` OnCallPageScheduledActionRelationshipsSchedules: The schedules the action escalates to. - `data` OnCallPageScheduledActionRelationshipsSchedulesData[]: The list of schedules. - … - `users` OnCallPageScheduledActionRelationshipsUsers: The users the action escalates to. - `data` OnCallPageUserRelationshipData[]: The list of users. - … - `type` 'scheduled_actions', required: Scheduled action resource type. - OnCallPageLink: A link between a Page and another Datadog resource, such as an incident. - `attributes` OnCallPageLinkAttributes: The attributes of a Page link. A Page can be the child of another Datadog resource (for example, when an incident triggers it), or the parent of one (for example, when the Page is escalated to an incident). - `child_entity_id` string, required: The ID of the child resource. - `child_entity_type` 'case' | 'incident' | 'page' | 'agent_conversation', required: The type of a resource linked to a Page. - `parent_entity_id` string, required: The ID of the parent resource. - `parent_entity_type` 'case' | 'incident' | 'page' | 'agent_conversation', required: The type of a resource linked to a Page. - `relationship` 'relates_to' | 'causes' | 'blocks' | 'duplicates' | 'parent_of' | 'successor_of' | 'escalates_to' | 'pages', required: How the parent resource relates to the child resource. - `id` string, required: The ID of the link. - `type` 'links', required: Page link resource type. - `meta` SchedulesResponseMeta: Metadata that is included in the response when listing On-Call resources. - `page` SchedulesResponseMetaPage: Metadata related to pagination information that is included in the response when listing On-Call resources. - `first_number` integer: First page number. - `last_number` integer: Last page number. - `next_number` integer, nullable: Next page number. - `number` integer: Page number. - `prev_number` integer, nullable: Previous page number. - `size` integer: Page size. - `total` integer: Total number of results. - `type` string: Pagination type. ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `404`: Not Found - `429`: Too many requests --- [API](https://skmtc.dev/datadog/apis/datadog-api-v2-collection.md) - [All operations](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/llms.txt) - [OpenAPI document](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/revisions/3f70db624329?raw)