Get a schedule

<Note>Please make sure to pass in the cal-api-version header value as mentioned in the Headers section. Not passing the correct value will default to an older version of this endpoint.</Note>

get/v2/schedules/{scheduleId}

Path parameters

scheduleIdnumber required

Headers

Authorizationstring required

value must be Bearer <token> where <token> is api key prefixed with cal_ or managed user access token

cal-api-versionstring required

Must be set to 2024-06-11. If not set to this value, the endpoint will default to an older version.

Response

status'success' | 'error' required

errorobject

Example response

{
  "status": "success",
  "data": {
    "id": 254,
    "ownerId": 478,
    "name": "Catch up hours",
    "timeZone": "Europe/Rome",
    "availability": [
      {
        "days": [
          "Monday",
          "Tuesday"
        ],
        "startTime": "17:00",
        "endTime": "19:00"
      },
      {
        "days": [
          "Wednesday",
          "Thursday"
        ],
        "startTime": "16:00",
        "endTime": "20:00"
      }
    ],
    "isDefault": true,
    "overrides": [
      {
        "date": "2024-05-20",
        "startTime": "18:00",
        "endTime": "21:00"
      }
    ]
  }
}

Changes

Changed in 2 of the 50 revisions of this API.715

Jul 17, 2026v216de9d3eb7b311See the full diff
- ○
  removed the Friday enum value from the data/allOf[ScheduleOutput_2024_06_11]/availability/items/days response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the Monday enum value from the data/allOf[ScheduleOutput_2024_06_11]/availability/items/days response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the Saturday enum value from the data/allOf[ScheduleOutput_2024_06_11]/availability/items/days response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the Sunday enum value from the data/allOf[ScheduleOutput_2024_06_11]/availability/items/days response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the Thursday enum value from the data/allOf[ScheduleOutput_2024_06_11]/availability/items/days response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the Tuesday enum value from the data/allOf[ScheduleOutput_2024_06_11]/availability/items/days response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the Wednesday enum value from the data/allOf[ScheduleOutput_2024_06_11]/availability/items/days response property for the response status 200
  response-property-enum-value-removed
- ○
  the data/allOf[ScheduleOutput_2024_06_11]/availability/items/endTime response's property pattern TIME_FORMAT_HH_MM was removed for the status 200
  response-property-pattern-removed
- ○
  the data/allOf[ScheduleOutput_2024_06_11]/availability/items/startTime response's property pattern TIME_FORMAT_HH_MM was removed for the status 200
  response-property-pattern-removed
- ○
  the data/allOf[ScheduleOutput_2024_06_11]/overrides/items/endTime response's property pattern TIME_FORMAT_HH_MM was removed for the status 200
  response-property-pattern-removed
- ○
  the data/allOf[ScheduleOutput_2024_06_11]/overrides/items/startTime response's property pattern TIME_FORMAT_HH_MM was removed for the status 200
  response-property-pattern-removed
This revision also has 197 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 26, 2025v2daa3e48bc03a74See the full diff
- ●
  added the new Friday enum value to the data/allOf[ScheduleOutput_2024_06_11]/availability/items/days response property for the response status 200
  response-property-enum-value-added
- ●
  added the new Monday enum value to the data/allOf[ScheduleOutput_2024_06_11]/availability/items/days response property for the response status 200
  response-property-enum-value-added
- ●
  added the new Saturday enum value to the data/allOf[ScheduleOutput_2024_06_11]/availability/items/days response property for the response status 200
  response-property-enum-value-added
- ●
  added the new Sunday enum value to the data/allOf[ScheduleOutput_2024_06_11]/availability/items/days response property for the response status 200
  response-property-enum-value-added
- ●
  added the new Thursday enum value to the data/allOf[ScheduleOutput_2024_06_11]/availability/items/days response property for the response status 200
  response-property-enum-value-added
- ●
  added the new Tuesday enum value to the data/allOf[ScheduleOutput_2024_06_11]/availability/items/days response property for the response status 200
  response-property-enum-value-added
- ●
  added the new Wednesday enum value to the data/allOf[ScheduleOutput_2024_06_11]/availability/items/days response property for the response status 200
  response-property-enum-value-added
- ○
  the data/allOf[ScheduleOutput_2024_06_11]/availability/items/endTime response's property pattern TIME_FORMAT_HH_MM was added for the status 200
  response-property-pattern-added
- ○
  the data/allOf[ScheduleOutput_2024_06_11]/availability/items/startTime response's property pattern TIME_FORMAT_HH_MM was added for the status 200
  response-property-pattern-added
- ○
  the data/allOf[ScheduleOutput_2024_06_11]/overrides/items/endTime response's property pattern TIME_FORMAT_HH_MM was added for the status 200
  response-property-pattern-added
- ○
  the data/allOf[ScheduleOutput_2024_06_11]/overrides/items/startTime response's property pattern TIME_FORMAT_HH_MM was added for the status 200
  response-property-pattern-added
This revision also has 46 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history