On-Call
List On-Call Pages
Retrieve a paginated list of On-Call Pages, optionally filtered by a search query and sorted by a field.
get/api/v2/on-call/pages
Request
- Base URLhttps://api.datadoghq.com
- Auth
- API key in header DD-API-KEY and API key in header DD-APPLICATION-KEY
- or OAuth 2Authorization code/oauth2/v1/authorizeToken URL/oauth2/v1/token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
page[size]integer
Example:100
Number of On-Call Pages to return per page of results. The maximum allowed value is 1000.
page[number]integer
Page of results to return, starting at 0. page[number] multiplied by page[size] must be less than 50000.
filter[query]string
Example:status:triggered
Search query to filter Pages. Supports filters such as status, urgency, team, service, and tags, for example status:triggered.
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.
Sort Pages by the given field. Only one field is allowed.
Response
OK
Example response
{
"data": [
{
"attributes": {
"acknowledged_at": "2026-01-01T10:05:00Z",
"closed_at": "2026-01-01T10:30:00Z",
"comment_count": 2,
"created_at": "2026-01-01T10:00:00Z",
"description": "Page details.",
"escalation_policy_uuid": "00000000-0000-0000-0000-000000000000",
"key": "25137717",
"live_call": {
"call_over": {
"outcome": "success_call_answered",
"support_hours_start_at": "2026-01-01T09:00:00Z"
}
},
"modified_at": "2026-01-01T10:30:00Z",
"release_at": "2026-01-01T11:00:00Z",
"release_origin": "manual_snooze",
"responders_added_at": "2026-01-01T10:01:00Z",
"services": [
"service-a"
],
"status": "triggered",
"tags": [
"service:test"
],
"title": "Service: Test is down",
"urgency": "high"
},
"id": "15e74b8b-f865-48d0-bcc5-453323ed2c8f",
"relationships": {
"author": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "users"
}
},
"closed_by": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "users"
}
},
"jira_issue": {
"data": {
"id": "123456:10001",
"type": "jira_issues"
}
},
"links": {
"data": [
{
"id": "00000000-0000-0000-0000-000000000003",
"type": "links"
}
]
},
"responders": {
"data": [
{
"id": "00000000-0000-0000-0000-000000000000",
"type": "users"
}
]
},
"scheduled_action": {
"data": {
"id": "15e74b8b-f865-48d0-bcc5-453323ed2c8f",
"type": "scheduled_actions"
}
},
"service_now_incident": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "service_now_incidents"
}
},
"target": {
"data": {
"id": "00000000-da3a-0000-0000-000000000000",
"type": "teams"
}
},
"team_routing_rule": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "team_routing_rules"
}
}
},
"type": "pages"
}
],
"included": [
{
"attributes": {
"color": "#FF0000",
"email": "jane.doe@example.com",
"name": "Jane Doe"
},
"id": "00000000-0000-0000-0000-000000000000",
"type": "users"
}
],
"meta": {
"page": {
"type": "number_size"
}
}
}Changes
Changes to this operation have not been checked yet.