The schedules endpoint in Cal.com's API suite allows you to set out time blocks when you want to show availability.
Schedule Object
| Attribute | Description |
|---|---|
| id | integer The ID of the schedule, generated automatically |
| user | User Object The user associated with the schedule |
| userId | integer The ID of the user associated with the schedule |
| eventType | EventType[] The event types associated with the schedule |
| name | string The name of the schedule |
| timeZone | string The time zone of the schedule |
| availability | Availability[] The availability settings for the schedule |
Example Schedule Object
{
"id": 101,
"user": [User Object],
"userId": 1,
"eventType": [EventType Object[]],
"name": "John's Weekly Schedule",
"timeZone": "America/New_York",
"availability": [Availability Object[]]
}
Find all schedules
Use this endpoint to list all schedules associated with your profile
GET
/schedules
Create a new schedule
Use this endpoint to create a new schedule for your Cal.com account
POST
/schedules
Find a schedule
Use this endpoint to list details of a specific schedule associated with your profile
GET
/schedules/{id}
Edit an existing schedule
Use this endpoint to edit details of a specific schedule associated with your profile
PATCH
/schedules/{id}
Remove an existing schedule
Use this endpoint to remove a specific schedule associated with your profile
DELETE
/schedules/{id}