---
title: "List schedules"
method: GET
path: "/api/{cloudId}/v1/schedules"
tags: ["Schedules"]
---

# List schedules

`GET /api/{cloudId}/v1/schedules`

Lists all schedules that user can view. It optionally takes two parameters - offset and size.<br> <br> **Permissions required:** Permission to access Jira Service Management; however, the list contains a schedule if: 
 - the user has read-only administrative right. 
 - the schedule's assigned team is one of the teams that the user belongs to. 
 - the user is added to a rotation of the schedule as a responder. 
 - a team is added to a rotation of the schedule as a responder, and the user is a member of this team. 
 - an escalation is added to a rotation of the schedule as a responder, and the user is a member of this escalation. 
 - there is an override to the user in the schedule.

## Query parameters

- `query` string
- `size` integer
- `offset` integer
- `expand` string[]

## Response `200`

Returned if the request is successful.

- ListSchedulesResponse
  - `values` Schedule[] — List of the schedules.
    - `id` string — ID of the schedule.
    - `name` string — Name of the schedule.
    - `description` string — Description of the schedule.
    - `timezone` string — Time zone ID of the schedule.
    - `enabled` boolean — Indicates whether the schedule is enabled or not.
    - `teamId` string — ID of the team that schedule belongs to.
    - `rotations` Rotation[] — Rotation details of the schedule.
      - `id` string — ID of the rotation.
      - `name` string — Name of the rotation.
      - `startDate` string, date-time — Start time of the rotation.
      - `endDate` string, date-time — End time of the rotation.
      - `type` 'daily' | 'weekly' | 'hourly' — Type of the rotation.
      - `length` integer — Length of the rotation based on type.
      - `participants` ResponderInfo[] — List of participants of the rotation.
        - `type` 'user' | 'team' | 'escalation' | 'noone', required — Type of the responder.
        - `id` string — ID of the responder. Null if the type is `noone`.
      - `timeRestriction` union
        - TimeOfDayTimeRestriction
          - `type` string — Type of the time restriction.
          - `restriction` TimeOfDayTimeRestrictionSettings — Details of the time restriction. Returned if the type of the time restriction is `time-of-day`.
            - `startHour` integer — Start hour of the time restriction.
            - `endHour` integer — End hour of the time restriction.
            - `startMin` integer — Start minute of the time restriction.
            - `endMin` integer — End minute of the time restriction.
        - WeekdayTimeRestriction
          - `type` string — Type of the time restriction.
          - `restrictions` WeekdayTimeRestrictionSettings[] — Details of the time restriction. Returned if the type of the time restriction is `weekday-and-time-of-day`.
            - `startDay` 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' | 'sunday' — Start day of the time restriction.
            - `endDay` 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' | 'sunday' — End day of the time restriction.
            - `startHour` integer — Start hour of the time restriction.
            - `endHour` integer — End hour of the time restriction.
            - `startMin` integer — Start minute of the time restriction.
            - `endMin` integer — End minute of the time restriction.
  - `links` SchedulePaginationLinks — Links for the other pages.
    - `next` string — Link to the next page of results.
  - `_expands` string[] — List of all possible expansions.

## Other responses

- `401` — Returned if the authentication credentials are incorrect.
- `422` — Returned if the query parameters cannot be validated.

---

[API](https://skmtc.net/atlassian/apis/jsm-operations-api.md) · [All operations](https://skmtc.net/atlassian/apis/jsm-operations-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/jsm-operations-api/versions/ed65f017bcb8/schema)