Calendars

Tags: calendars, scheduling

Endpoints

• GET - List
• POST - Create
• DELETE /{calendar_id} - Delete Calendar Id
• GET /{calendar_id} - Get Calendar Id
• PUT /{calendar_id} - Update Calendar Id
• GET /{calendar_id}/schedules - Schedules
• POST /{calendar_id}/schedules - Schedules
• DELETE /{calendar_id}/schedules/{schedule_id} - Delete Schedules
• PUT /{calendar_id}/schedules/{schedule_id} - Update Schedules

List

GET /api/v2/w/{workspace_uuid}/calendars

Description:

Calendar and scheduling management

List all calendars accessible to the authenticated user.

Authorization: Requires calendars:read scope

Parameters:

• page (Integer)
• pageSize (Integer)
• includeSchedules (Boolean)

Response: See PaginatedResponse[CalendarResponse]

---

Create

POST /api/v2/w/{workspace_uuid}/calendars

Description:

Calendar and scheduling management

Create a new calendar.

Creates an open/unconstrained calendar by default. Users can add schedules and event types later through the edit interface.

Authorization: Requires calendars:write scope

Parameters:

• request - See CreateCalendarRequest

Response: See CalendarResponse

---

Delete Calendar Id

DELETE /api/v2/w/{workspace_uuid}/calendars/{calendar_id}

Description:

Calendar and scheduling management

Delete a calendar.

Authorization: Requires calendars:admin scope

Parameters:

• calendar_id (Integer)

Response: See dict

---

Get Calendar Id

GET /api/v2/w/{workspace_uuid}/calendars/{calendar_id}

Description:

Calendar and scheduling management

Get a specific calendar by ID.

Authorization: Requires calendars:read scope

Parameters:

• calendar_id (Integer)
• includeSchedules (Boolean)

Response: See CalendarResponse

---

Update Calendar Id

PUT /api/v2/w/{workspace_uuid}/calendars/{calendar_id}

Description:

Calendar and scheduling management

Update an existing calendar.

Authorization: Requires calendars:write scope

Parameters:

• calendar_id (Integer)
• request - See UpdateCalendarRequest

Response: See CalendarResponse

---

Schedules

GET /api/v2/w/{workspace_uuid}/calendars/{calendar_id}/schedules

Description:

Calendar and scheduling management

List all schedules for a calendar.

Authorization: Requires calendars:read scope

Parameters:

• calendar_id (Integer)

Response: List of CalendarScheduleResponse

---

Schedules

POST /api/v2/w/{workspace_uuid}/calendars/{calendar_id}/schedules

Description:

Calendar and scheduling management

Create a new schedule for a calendar.

Authorization: Requires calendars:write scope

Parameters:

• calendar_id (Integer)
• request - See CreateCalendarScheduleRequest

Response: See CalendarScheduleResponse

---

Delete Schedules

DELETE /api/v2/w/{workspace_uuid}/calendars/{calendar_id}/schedules/{schedule_id}

Description:

Calendar and scheduling management

Delete a schedule.

Authorization: Requires calendars:admin scope

Parameters:

• calendar_id (Integer)
• schedule_id (Integer)

Response: See dict

---

Update Schedules

PUT /api/v2/w/{workspace_uuid}/calendars/{calendar_id}/schedules/{schedule_id}

Description:

Calendar and scheduling management

Update an existing schedule.

Authorization: Requires calendars:write scope

Parameters:

• calendar_id (Integer)
• schedule_id (Integer)
• request - See UpdateCalendarScheduleRequest

Response: See CalendarScheduleResponse

---