---
title: "Get Schedule By ID"
method: GET
path: "/v1/schedules/{scheduleId}"
tags: ["Schedules"]
---

# Get Schedule By ID

`GET /v1/schedules/{scheduleId}`

## Request

- Base URL: `https://api.bouncie.dev`
- URL: `https://api.bouncie.dev/v1/schedules/{scheduleId}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/bouncie/apis/bouncie-api/docs/v1/schedules/:scheduleId/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `scheduleId` string, required

## Headers

- `Authorization` string: User access token
- `Content-Type` 'application/json'

## Response `200`

Returns a schedule

- object
  - `id` string, required: Unique identifier for the schedule
  - `name` string, required: Name of the schedule
  - `referenceTz` string, required: [Time zone identifier](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for the schedule
  - `schedule` object[], required: The different schedules that will trigger an event
    - `daysOfWeek` integer[], required: Days of the week the schedule times are active where 0 represents Sunday and 6 represents Saturday.
    - `times` object[], required: The time segments throughout the day represented in seconds that the schedule is active.
      - `startTime` integer, required
      - `endTime` integer, required

## Other responses

- `404`: Responds with a status code of 404 if a schedule could not be found

---

[API](https://skmtc.dev/bouncie/apis/bouncie-api.md) - [All operations](https://skmtc.dev/bouncie/apis/bouncie-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bouncie/apis/bouncie-api/revisions/7b4fc4cc0eb9?raw)