---
title: "GET /api/im/schedules/{id}"
method: GET
path: "/api/im/schedules/{id}"
tags: ["Im"]
---

# GET /api/im/schedules/{id}

`GET /api/im/schedules/{id}`

## Request

- Base URL: `https://uptimeify.io`
- URL: `https://uptimeify.io/api/im/schedules/{id}`
- Auth: HTTP bearer

## Path parameters

- `id` string, required

## Response `200`

Successful response

- object
  - `id` integer, required
  - `organizationId` integer, required
  - `teamId` integer, required
  - `tierId` integer, required
  - `name` string, required
  - `timezone` string, required
  - `effectiveFrom` string, date-time, nullable, required
  - `effectiveUntil` string, date-time, nullable, required
  - `weeklySchedules` object[], nullable, required
    - `from` string, required
    - `until` union, required
      - string
      - '24:00'
    - `days` integer[], required
  - `rotationMode` 'none' | 'auto' | 'explicit', required: Default none. auto/explicit require rotationRepeats and startsOnTime.
  - `rotationRepeats` 'daily' | 'weekly' | 'biweekly' | 'monthly' | 'custom', nullable, required: Required unless rotationMode is none (then it must be null).
  - `customRepeatUnit` 'minutes' | 'hours' | 'days' | 'weeks' | 'months', nullable, required: Required when rotationRepeats is custom.
  - `customRepeatValue` integer, nullable, required: Required when rotationRepeats is custom.
  - `autoRotationSize` integer, nullable, required: Required when rotationMode is auto.
  - `roundRobinSize` integer, required
  - `startsOnDayOfWeek` integer, nullable, required: Required for weekly, biweekly and custom weeks rotations.
  - `startsOnDateOfMonth` integer, nullable, required: Required for monthly and custom months rotations.
  - `startsOnTime` string, nullable, required: Handover time; required unless rotationMode is none.
  - `roundRobinCursor` integer, required
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required
  - `team` object, nullable, required
    - `id` integer, required
    - `name` string, required
  - `overrides` object[], required
    - `id` integer, required
    - `scheduleId` integer, nullable, required: null = team-level override (team without schedule).
    - `userId` string, required
    - `userName` string, nullable, required
    - `userImage` string, nullable, required
    - `type` 'online' | 'offline', required
    - `applyScope` 'this_team' | 'all_teams', required
    - `escalationTierOrder` integer, nullable, required
    - `startsAt` string, date-time, required
    - `endsAt` string, date-time, required
    - `createdAt` string, date-time, required
    - `coveredBy` object[], required
      - `userId` string, required
      - `userName` string, nullable, required
      - `userImage` string, nullable, required

## Other responses

- `400`: Invalid or missing parameters.
- `401`: Missing, invalid or expired API token.
- `404`: No such resource, or not visible to this token.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api.md) · [All operations](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api/revisions/2129a771ee7e?raw)