---
title: "Get schedule timeline"
method: GET
path: "/api/{cloudId}/v1/schedules/{scheduleId}/timeline"
tags: ["Schedule timelines"]
---

# Get schedule timeline

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

Returns the timeline of the schedule with given id in the request. The time range of the timeline can go back at most one year from today and as far as two years from today. Therefore, query parameters should be given accordingly.<br> <br> **Permissions required:** Permission to access to the schedule: 
 - 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.

## Path parameters

- `scheduleId` string, required

## Query parameters

- `interval` integer
- `intervalUnit` 'days' | 'weeks' | 'months'
- `date` string, date-time
- `expand` string[]

## Response `200`

Returned if the request is successful.

- ScheduleTimelineResponse
  - `startDate` string, date-time — Start time of the timeline.
  - `endDate` string, date-time — End time of the timeline.
  - `finalTimeline` Timeline — Timeline details for the layer.
    - `rotations` TimelineRotation[]
      - `id` string — ID of the rotation.
      - `name` string — Name of the rotation.
      - `order` number, float — Order of the rotation. Empty if the rotation has been deleted.
      - `deleted` boolean — Indicates whether the rotation is deleted or not.
      - `periods` TimelinePeriod[] — List of the on-call periods that belong to the rotation.
        - `startDate` string, date-time — Start time of the on-call period.
        - `endDate` string, date-time — End time of the on-call period.
        - `type` 'base' | 'override' | 'forwarding' | 'historical' — Type of the on-call period.
        - `from` ForwardingResponder — Information of the forwarding user.
          - `id` string — ID of the responder.
          - `type` 'user' — Type of the responder.
          - `deleted` boolean — Indicates whether the responder is deleted or not.
        - `responder` TimelineResponder — The responder of the on-call period.
          - `id` string — ID of the responder.
          - `type` 'user' | 'team' | 'escalation' | 'noone' — Type of the responder.
          - `deleted` boolean — Indicates whether the responder is deleted or not.
        - `flattenedResponders` TimelineResponder[] — List of the flattened responders of the on-call period.
          - `id` string — ID of the responder.
          - `type` 'user' | 'team' | 'escalation' | 'noone' — Type of the responder.
          - `deleted` boolean — Indicates whether the responder is deleted or not.
  - `baseTimeline` Timeline — Timeline details for the layer.
    - `rotations` TimelineRotation[]
      - `id` string — ID of the rotation.
      - `name` string — Name of the rotation.
      - `order` number, float — Order of the rotation. Empty if the rotation has been deleted.
      - `deleted` boolean — Indicates whether the rotation is deleted or not.
      - `periods` TimelinePeriod[] — List of the on-call periods that belong to the rotation.
        - `startDate` string, date-time — Start time of the on-call period.
        - `endDate` string, date-time — End time of the on-call period.
        - `type` 'base' | 'override' | 'forwarding' | 'historical' — Type of the on-call period.
        - `from` ForwardingResponder — Information of the forwarding user.
          - `id` string — ID of the responder.
          - `type` 'user' — Type of the responder.
          - `deleted` boolean — Indicates whether the responder is deleted or not.
        - `responder` TimelineResponder — The responder of the on-call period.
          - `id` string — ID of the responder.
          - `type` 'user' | 'team' | 'escalation' | 'noone' — Type of the responder.
          - `deleted` boolean — Indicates whether the responder is deleted or not.
        - `flattenedResponders` TimelineResponder[] — List of the flattened responders of the on-call period.
          - `id` string — ID of the responder.
          - `type` 'user' | 'team' | 'escalation' | 'noone' — Type of the responder.
          - `deleted` boolean — Indicates whether the responder is deleted or not.
  - `overrideTimeline` Timeline — Timeline details for the layer.
    - `rotations` TimelineRotation[]
      - `id` string — ID of the rotation.
      - `name` string — Name of the rotation.
      - `order` number, float — Order of the rotation. Empty if the rotation has been deleted.
      - `deleted` boolean — Indicates whether the rotation is deleted or not.
      - `periods` TimelinePeriod[] — List of the on-call periods that belong to the rotation.
        - `startDate` string, date-time — Start time of the on-call period.
        - `endDate` string, date-time — End time of the on-call period.
        - `type` 'base' | 'override' | 'forwarding' | 'historical' — Type of the on-call period.
        - `from` ForwardingResponder — Information of the forwarding user.
          - `id` string — ID of the responder.
          - `type` 'user' — Type of the responder.
          - `deleted` boolean — Indicates whether the responder is deleted or not.
        - `responder` TimelineResponder — The responder of the on-call period.
          - `id` string — ID of the responder.
          - `type` 'user' | 'team' | 'escalation' | 'noone' — Type of the responder.
          - `deleted` boolean — Indicates whether the responder is deleted or not.
        - `flattenedResponders` TimelineResponder[] — List of the flattened responders of the on-call period.
          - `id` string — ID of the responder.
          - `type` 'user' | 'team' | 'escalation' | 'noone' — Type of the responder.
          - `deleted` boolean — Indicates whether the responder is deleted or not.
  - `forwardingTimeline` Timeline — Timeline details for the layer.
    - `rotations` TimelineRotation[]
      - `id` string — ID of the rotation.
      - `name` string — Name of the rotation.
      - `order` number, float — Order of the rotation. Empty if the rotation has been deleted.
      - `deleted` boolean — Indicates whether the rotation is deleted or not.
      - `periods` TimelinePeriod[] — List of the on-call periods that belong to the rotation.
        - `startDate` string, date-time — Start time of the on-call period.
        - `endDate` string, date-time — End time of the on-call period.
        - `type` 'base' | 'override' | 'forwarding' | 'historical' — Type of the on-call period.
        - `from` ForwardingResponder — Information of the forwarding user.
          - `id` string — ID of the responder.
          - `type` 'user' — Type of the responder.
          - `deleted` boolean — Indicates whether the responder is deleted or not.
        - `responder` TimelineResponder — The responder of the on-call period.
          - `id` string — ID of the responder.
          - `type` 'user' | 'team' | 'escalation' | 'noone' — Type of the responder.
          - `deleted` boolean — Indicates whether the responder is deleted or not.
        - `flattenedResponders` TimelineResponder[] — List of the flattened responders of the on-call period.
          - `id` string — ID of the responder.
          - `type` 'user' | 'team' | 'escalation' | 'noone' — Type of the responder.
          - `deleted` boolean — Indicates whether the responder is deleted or not.
  - `_expands` string[] — List of all possible expansions.

## Other responses

- `401` — Returned if the authentication credentials are incorrect.
- `403` — Returned if the requesting user does not have permission to view the schedule.
- `404` — Returned if the schedule is not found.
- `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/revisions/ed65f017bcb8/schema)