Schedules
Get a schedule
Getting Started
Platform / Cal Provider
Platform / Managed Users
Platform / Webhooks
Orgs / Attributes
Orgs / Attributes / Options
Orgs / Delegation Credentials
Orgs / Event Types
Orgs / Memberships
Orgs / Orgs
Orgs / Schedules
Orgs / Teams
Orgs / Teams / Bookings
Orgs / Teams / Memberships
Orgs / Teams / Routing forms / Responses
Orgs / Teams / Schedules
Orgs / Users / OOO
Orgs / Webhooks
Api Keys
Bookings
- GETGet all bookings
- POSTCreate a booking
- GETGet a booking
- POSTReschedule a booking
- POSTCancel a booking
- POSTMark a booking absence
- POSTAutomatically reassign booking to a new host
- POSTReassign a booking to a specific user
- POSTConfirm booking that requires a confirmation
- POSTDecline booking that requires a confirmation
- GETGet 'Add to Calendar' links for a booking
Calendars
Conferencing
Destination Calendars
Event Types
Event Types / Webhooks
OAuth Clients
Schedules
Selected Calendars
Slots
Stripe
Teams / Event Types
Teams / Memberships
Timezones
Schedules
Get a schedule
GET
/
v2
/
schedules
/
{scheduleId}
curl --request GET \
--url https://api.cal.com/v2/schedules/{scheduleId} \
--header 'Authorization: <authorization>' \
--header 'cal-api-version: <cal-api-version>'
{
"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"
}
]
},
"error": {}
}
Headers
value must be Bearer <token>
where <token>
either managed user access token or api key prefixed with cal_
Must be set to 2024-06-11
Path Parameters
Response
200 - application/json
Available options:
success
, error
Example:
"success"
Example:
254
Example:
478
Example:
"Catch up hours"
Example:
"Europe/Rome"
Array of days when schedule is active.
Available options:
Monday
, Tuesday
, Wednesday
, Thursday
, Friday
, Saturday
, Sunday
Example:
["Monday", "Tuesday"]
startTime must be a valid time in format HH:MM e.g. 08:00
Example:
"08:00"
endTime must be a valid time in format HH:MM e.g. 15:00
Example:
"15:00"
Example:
[
{
"days": ["Monday", "Tuesday"],
"startTime": "17:00",
"endTime": "19:00"
},
{
"days": ["Wednesday", "Thursday"],
"startTime": "16:00",
"endTime": "20:00"
}
]
Example:
true
Example:
[
{
"date": "2024-05-20",
"startTime": "18:00",
"endTime": "21:00"
}
]
Was this page helpful?
curl --request GET \
--url https://api.cal.com/v2/schedules/{scheduleId} \
--header 'Authorization: <authorization>' \
--header 'cal-api-version: <cal-api-version>'
{
"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"
}
]
},
"error": {}
}