---
title: "List On-Call schedules"
method: GET
path: "/api/v2/on-call/schedules"
tags: ["On-Call"]
---

# List On-Call schedules

`GET /api/v2/on-call/schedules`

## Request

- Base URL: `https://api.datadoghq.com`
- URL: `https://api.datadoghq.com/api/v2/on-call/schedules`
- 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: <https://skmtc.dev/datadog/apis/datadog-api-v2-collection/docs/api/v2/on-call/schedules/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a list of On-Call schedules.

## Query parameters

- `page[size]` integer
- `page[number]` integer
- `filter[query]` string
- `include` string

## Response `200`

OK

- Schedules: A list of schedules with pagination metadata and any related included resources (such as teams).
  - `data` ScheduleListItem[]: A list of schedules.
    - `attributes` ScheduleDataAttributes: Provides core properties of a schedule object such as its name and time zone.
      - `max_responders` integer: 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.
      - `name` string: A short name for the schedule.
      - `tags` string[]: A list of tags associated with the schedule.
      - `time_zone` string: The time zone in which this schedule operates.
    - `id` string, required: The schedule's unique identifier.
    - `relationships` ScheduleListItemRelationships: Groups the relationships for a schedule summary, referencing its teams.
      - `teams` DataRelationshipsTeams: Associates teams with this schedule in a data structure.
        - `data` DataRelationshipsTeamsDataItems[]: An array of team references for this schedule.
          - `id` string, required: The unique identifier of the team in this relationship.
          - `type` 'teams', required: Teams resource type.
    - `type` 'schedules', required: Schedules resource type.
  - `included` TeamReference[]: Any additional resources related to the schedules, such as teams.
    - `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.
  - `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
- `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)