# Calendar Events

Operations related to calendar events

## Get calendar events

> Retrieve a paginated list of calendar events with optional filtering

```json
{"openapi":"3.0.0","info":{"title":"Salescaling API","version":"1.0"},"tags":[{"name":"Calendar Events","description":"Operations related to calendar events"}],"servers":[{"url":"https://api.salescaling.com","description":"Base API URL"}],"security":[{},{"bearer":[]}],"paths":{"/api/v1/calendar-events":{"get":{"operationId":"PublicApiCalendarEventController_getCalendarEvents","summary":"Get calendar events","description":"Retrieve a paginated list of calendar events with optional filtering","parameters":[{"name":"startDate","required":false,"in":"query","description":"Filter calendar events by start date","schema":{"type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Filter calendar events by end date","schema":{"type":"string"}},{"name":"calendarId","required":false,"in":"query","description":"Filter calendar events by calendar ID","schema":{"type":"string"}},{"name":"status","required":false,"in":"query","description":"Filter calendar events by status","schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"Page number","schema":{"type":"string"}},{"name":"limit","required":false,"in":"query","description":"Number of items per page","schema":{"type":"string"}}],"responses":{"200":{"description":"Calendar events retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiGetCalendarEventsResponseDto"}}}},"401":{"description":"Unauthorized - missing or invalid API key or Bearer token"}},"tags":["Calendar Events"]}}},"components":{"schemas":{"PublicApiGetCalendarEventsResponseDto":{"type":"object","properties":{"statusCode":{"type":"number","default":200},"count":{"type":"number"},"error":{"type":"string","nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicApiCalendarEventDto"}}},"required":["statusCode","count","error","data"]},"PublicApiCalendarEventDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the calendar event"},"calendarId":{"type":"string","description":"Calendar ID this event belongs to"},"title":{"type":"string","description":"Title of the calendar event"},"description":{"type":"string","description":"Description of the calendar event"},"startDateTime":{"format":"date-time","type":"string","description":"Date and time when the event starts"},"endDateTime":{"format":"date-time","type":"string","description":"Date and time when the event ends"},"location":{"type":"string","description":"Location of the event"},"status":{"type":"string","enum":["completed","confirmed","tentative","cancelled"],"description":"Status of the calendar event"},"visibility":{"type":"string","enum":["default","public","private"],"description":"Visibility of the calendar event"},"organizerEmail":{"type":"string","description":"Email of the event organizer"},"organizerName":{"type":"string","description":"Name of the event organizer"},"busy":{"type":"boolean","description":"Whether the event is marked as busy"},"readOnly":{"type":"boolean","description":"Whether the event is read-only"},"hideParticipants":{"type":"boolean","description":"Whether to hide participants"},"htmlLink":{"type":"string","description":"HTML link to the event"},"iCalUID":{"type":"string","description":"iCal UID of the event"},"nylasId":{"type":"string","description":"Nylas ID of the event"},"masterEventId":{"type":"string","description":"Master event ID for recurring events"},"duration":{"type":"number","description":"Duration of the event in seconds"},"recurrence":{"description":"Recurrence rules for the event","type":"array","items":{"type":"string"}},"participants":{"description":"Event participants","type":"array","items":{"$ref":"#/components/schemas/PublicApiCalendarEventParticipantDto"}},"conferencing":{"description":"Conferencing properties","allOf":[{"$ref":"#/components/schemas/PublicApiCalendarEventConferencingDto"}]},"metadata":{"type":"object","description":"Additional metadata for the event"},"createdAt":{"format":"date-time","type":"string","description":"Date and time when the event was created"},"updatedAt":{"format":"date-time","type":"string","description":"Date and time when the event was last updated"}},"required":["id","title","startDateTime","endDateTime","status","visibility","createdAt","updatedAt"]},"PublicApiCalendarEventParticipantDto":{"type":"object","properties":{"email":{"type":"string","description":"Email address of the participant"},"name":{"type":"string","description":"Name of the participant"},"status":{"type":"string","description":"Response status of the participant","default":"yes"}},"required":["email"]},"PublicApiCalendarEventConferencingDto":{"type":"object","properties":{"provider":{"type":"string","description":"Conferencing provider"},"details":{"type":"object","properties":{"url":{"type":"string"}}}},"required":["details"]}}}}
```

## Create calendar event

> Create a new calendar event

```json
{"openapi":"3.0.0","info":{"title":"Salescaling API","version":"1.0"},"tags":[{"name":"Calendar Events","description":"Operations related to calendar events"}],"servers":[{"url":"https://api.salescaling.com","description":"Base API URL"}],"security":[{},{"bearer":[]}],"paths":{"/api/v1/calendar-events":{"post":{"operationId":"PublicApiCalendarEventController_createCalendarEvent","summary":"Create calendar event","description":"Create a new calendar event","parameters":[],"requestBody":{"required":true,"description":"Calendar event data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiCreateCalendarEventDto"}}}},"responses":{"201":{"description":"Calendar event created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiCreateCalendarEventResponseDto"}}}},"401":{"description":"Unauthorized - missing or invalid API key or Bearer token"}},"tags":["Calendar Events"]}}},"components":{"schemas":{"PublicApiCreateCalendarEventDto":{"type":"object","properties":{"calendarId":{"type":"string","description":"Calendar ID this event belongs to"},"title":{"type":"string","description":"Title of the calendar event"},"description":{"type":"string","description":"Description of the calendar event"},"startDateTime":{"format":"date-time","type":"string","description":"Date and time when the event starts"},"endDateTime":{"format":"date-time","type":"string","description":"Date and time when the event ends"},"location":{"type":"string","description":"Location of the event"},"status":{"type":"string","enum":["completed","confirmed","tentative","cancelled"],"description":"Status of the calendar event"},"visibility":{"type":"string","enum":["default","public","private"],"description":"Visibility of the calendar event"},"organizerEmail":{"type":"string","description":"Email of the event organizer"},"organizerName":{"type":"string","description":"Name of the event organizer"},"busy":{"type":"boolean","description":"Whether the event is marked as busy"},"readOnly":{"type":"boolean","description":"Whether the event is read-only"},"hideParticipants":{"type":"boolean","description":"Whether to hide participants"},"duration":{"type":"number","description":"Duration of the event in seconds"},"recurrence":{"description":"Recurrence rules for the event","type":"array","items":{"type":"string"}},"participants":{"description":"Event participants","type":"array","items":{"$ref":"#/components/schemas/PublicApiCalendarEventParticipantDto"}},"meetingUrl":{"type":"string","description":"Meeting URL"},"metadata":{"type":"object","description":"Additional metadata for the event"}},"required":["calendarId","title","startDateTime","endDateTime"]},"PublicApiCalendarEventParticipantDto":{"type":"object","properties":{"email":{"type":"string","description":"Email address of the participant"},"name":{"type":"string","description":"Name of the participant"},"status":{"type":"string","description":"Response status of the participant","default":"yes"}},"required":["email"]},"PublicApiCreateCalendarEventResponseDto":{"type":"object","properties":{"statusCode":{"type":"number","default":200},"count":{"type":"number"},"error":{"type":"string","nullable":true},"data":{"$ref":"#/components/schemas/PublicApiCalendarEventDto"}},"required":["statusCode","count","error","data"]},"PublicApiCalendarEventDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the calendar event"},"calendarId":{"type":"string","description":"Calendar ID this event belongs to"},"title":{"type":"string","description":"Title of the calendar event"},"description":{"type":"string","description":"Description of the calendar event"},"startDateTime":{"format":"date-time","type":"string","description":"Date and time when the event starts"},"endDateTime":{"format":"date-time","type":"string","description":"Date and time when the event ends"},"location":{"type":"string","description":"Location of the event"},"status":{"type":"string","enum":["completed","confirmed","tentative","cancelled"],"description":"Status of the calendar event"},"visibility":{"type":"string","enum":["default","public","private"],"description":"Visibility of the calendar event"},"organizerEmail":{"type":"string","description":"Email of the event organizer"},"organizerName":{"type":"string","description":"Name of the event organizer"},"busy":{"type":"boolean","description":"Whether the event is marked as busy"},"readOnly":{"type":"boolean","description":"Whether the event is read-only"},"hideParticipants":{"type":"boolean","description":"Whether to hide participants"},"htmlLink":{"type":"string","description":"HTML link to the event"},"iCalUID":{"type":"string","description":"iCal UID of the event"},"nylasId":{"type":"string","description":"Nylas ID of the event"},"masterEventId":{"type":"string","description":"Master event ID for recurring events"},"duration":{"type":"number","description":"Duration of the event in seconds"},"recurrence":{"description":"Recurrence rules for the event","type":"array","items":{"type":"string"}},"participants":{"description":"Event participants","type":"array","items":{"$ref":"#/components/schemas/PublicApiCalendarEventParticipantDto"}},"conferencing":{"description":"Conferencing properties","allOf":[{"$ref":"#/components/schemas/PublicApiCalendarEventConferencingDto"}]},"metadata":{"type":"object","description":"Additional metadata for the event"},"createdAt":{"format":"date-time","type":"string","description":"Date and time when the event was created"},"updatedAt":{"format":"date-time","type":"string","description":"Date and time when the event was last updated"}},"required":["id","title","startDateTime","endDateTime","status","visibility","createdAt","updatedAt"]},"PublicApiCalendarEventConferencingDto":{"type":"object","properties":{"provider":{"type":"string","description":"Conferencing provider"},"details":{"type":"object","properties":{"url":{"type":"string"}}}},"required":["details"]}}}}
```

## Get calendar event by ID

> Retrieve a specific calendar event by its ID

```json
{"openapi":"3.0.0","info":{"title":"Salescaling API","version":"1.0"},"tags":[{"name":"Calendar Events","description":"Operations related to calendar events"}],"servers":[{"url":"https://api.salescaling.com","description":"Base API URL"}],"security":[{},{"bearer":[]}],"paths":{"/api/v1/calendar-events/{id}":{"get":{"operationId":"PublicApiCalendarEventController_getCalendarEventById","summary":"Get calendar event by ID","description":"Retrieve a specific calendar event by its ID","parameters":[{"name":"id","required":true,"in":"path","description":"Calendar event ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Calendar event retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiGetCalendarEventByIdResponseDto"}}}},"401":{"description":"Unauthorized - missing or invalid API key or Bearer token"}},"tags":["Calendar Events"]}}},"components":{"schemas":{"PublicApiGetCalendarEventByIdResponseDto":{"type":"object","properties":{"statusCode":{"type":"number","default":200},"count":{"type":"number"},"error":{"type":"string","nullable":true},"data":{"$ref":"#/components/schemas/PublicApiCalendarEventDto"}},"required":["statusCode","count","error","data"]},"PublicApiCalendarEventDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the calendar event"},"calendarId":{"type":"string","description":"Calendar ID this event belongs to"},"title":{"type":"string","description":"Title of the calendar event"},"description":{"type":"string","description":"Description of the calendar event"},"startDateTime":{"format":"date-time","type":"string","description":"Date and time when the event starts"},"endDateTime":{"format":"date-time","type":"string","description":"Date and time when the event ends"},"location":{"type":"string","description":"Location of the event"},"status":{"type":"string","enum":["completed","confirmed","tentative","cancelled"],"description":"Status of the calendar event"},"visibility":{"type":"string","enum":["default","public","private"],"description":"Visibility of the calendar event"},"organizerEmail":{"type":"string","description":"Email of the event organizer"},"organizerName":{"type":"string","description":"Name of the event organizer"},"busy":{"type":"boolean","description":"Whether the event is marked as busy"},"readOnly":{"type":"boolean","description":"Whether the event is read-only"},"hideParticipants":{"type":"boolean","description":"Whether to hide participants"},"htmlLink":{"type":"string","description":"HTML link to the event"},"iCalUID":{"type":"string","description":"iCal UID of the event"},"nylasId":{"type":"string","description":"Nylas ID of the event"},"masterEventId":{"type":"string","description":"Master event ID for recurring events"},"duration":{"type":"number","description":"Duration of the event in seconds"},"recurrence":{"description":"Recurrence rules for the event","type":"array","items":{"type":"string"}},"participants":{"description":"Event participants","type":"array","items":{"$ref":"#/components/schemas/PublicApiCalendarEventParticipantDto"}},"conferencing":{"description":"Conferencing properties","allOf":[{"$ref":"#/components/schemas/PublicApiCalendarEventConferencingDto"}]},"metadata":{"type":"object","description":"Additional metadata for the event"},"createdAt":{"format":"date-time","type":"string","description":"Date and time when the event was created"},"updatedAt":{"format":"date-time","type":"string","description":"Date and time when the event was last updated"}},"required":["id","title","startDateTime","endDateTime","status","visibility","createdAt","updatedAt"]},"PublicApiCalendarEventParticipantDto":{"type":"object","properties":{"email":{"type":"string","description":"Email address of the participant"},"name":{"type":"string","description":"Name of the participant"},"status":{"type":"string","description":"Response status of the participant","default":"yes"}},"required":["email"]},"PublicApiCalendarEventConferencingDto":{"type":"object","properties":{"provider":{"type":"string","description":"Conferencing provider"},"details":{"type":"object","properties":{"url":{"type":"string"}}}},"required":["details"]}}}}
```

## Update calendar event

> Update an existing calendar event

```json
{"openapi":"3.0.0","info":{"title":"Salescaling API","version":"1.0"},"tags":[{"name":"Calendar Events","description":"Operations related to calendar events"}],"servers":[{"url":"https://api.salescaling.com","description":"Base API URL"}],"security":[{},{"bearer":[]}],"paths":{"/api/v1/calendar-events/{id}":{"put":{"operationId":"PublicApiCalendarEventController_updateCalendarEvent","summary":"Update calendar event","description":"Update an existing calendar event","parameters":[{"name":"id","required":true,"in":"path","description":"Calendar event ID","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Updated calendar event data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiUpdateCalendarEventDto"}}}},"responses":{"200":{"description":"Calendar event updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiUpdateCalendarEventResponseDto"}}}},"401":{"description":"Unauthorized - missing or invalid API key or Bearer token"}},"tags":["Calendar Events"]}}},"components":{"schemas":{"PublicApiUpdateCalendarEventDto":{"type":"object","properties":{"title":{"type":"string","description":"Title of the calendar event"},"description":{"type":"string","description":"Description of the calendar event"},"startDateTime":{"format":"date-time","type":"string","description":"Date and time when the event starts"},"endDateTime":{"format":"date-time","type":"string","description":"Date and time when the event ends"},"location":{"type":"string","description":"Location of the event"},"status":{"type":"string","enum":["completed","confirmed","tentative","cancelled"],"description":"Status of the calendar event"},"visibility":{"type":"string","enum":["default","public","private"],"description":"Visibility of the calendar event"},"organizerEmail":{"type":"string","description":"Email of the event organizer"},"organizerName":{"type":"string","description":"Name of the event organizer"},"busy":{"type":"boolean","description":"Whether the event is marked as busy"},"readOnly":{"type":"boolean","description":"Whether the event is read-only"},"hideParticipants":{"type":"boolean","description":"Whether to hide participants"},"duration":{"type":"number","description":"Duration of the event in seconds"},"recurrence":{"description":"Recurrence rules for the event","type":"array","items":{"type":"string"}},"participants":{"description":"Event participants","type":"array","items":{"$ref":"#/components/schemas/PublicApiCalendarEventParticipantDto"}},"meetingUrl":{"type":"string","description":"Meeting URL"},"metadata":{"type":"object","description":"Additional metadata for the event"}}},"PublicApiCalendarEventParticipantDto":{"type":"object","properties":{"email":{"type":"string","description":"Email address of the participant"},"name":{"type":"string","description":"Name of the participant"},"status":{"type":"string","description":"Response status of the participant","default":"yes"}},"required":["email"]},"PublicApiUpdateCalendarEventResponseDto":{"type":"object","properties":{"statusCode":{"type":"number","default":200},"count":{"type":"number"},"error":{"type":"string","nullable":true},"data":{"$ref":"#/components/schemas/PublicApiCalendarEventDto"}},"required":["statusCode","count","error","data"]},"PublicApiCalendarEventDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the calendar event"},"calendarId":{"type":"string","description":"Calendar ID this event belongs to"},"title":{"type":"string","description":"Title of the calendar event"},"description":{"type":"string","description":"Description of the calendar event"},"startDateTime":{"format":"date-time","type":"string","description":"Date and time when the event starts"},"endDateTime":{"format":"date-time","type":"string","description":"Date and time when the event ends"},"location":{"type":"string","description":"Location of the event"},"status":{"type":"string","enum":["completed","confirmed","tentative","cancelled"],"description":"Status of the calendar event"},"visibility":{"type":"string","enum":["default","public","private"],"description":"Visibility of the calendar event"},"organizerEmail":{"type":"string","description":"Email of the event organizer"},"organizerName":{"type":"string","description":"Name of the event organizer"},"busy":{"type":"boolean","description":"Whether the event is marked as busy"},"readOnly":{"type":"boolean","description":"Whether the event is read-only"},"hideParticipants":{"type":"boolean","description":"Whether to hide participants"},"htmlLink":{"type":"string","description":"HTML link to the event"},"iCalUID":{"type":"string","description":"iCal UID of the event"},"nylasId":{"type":"string","description":"Nylas ID of the event"},"masterEventId":{"type":"string","description":"Master event ID for recurring events"},"duration":{"type":"number","description":"Duration of the event in seconds"},"recurrence":{"description":"Recurrence rules for the event","type":"array","items":{"type":"string"}},"participants":{"description":"Event participants","type":"array","items":{"$ref":"#/components/schemas/PublicApiCalendarEventParticipantDto"}},"conferencing":{"description":"Conferencing properties","allOf":[{"$ref":"#/components/schemas/PublicApiCalendarEventConferencingDto"}]},"metadata":{"type":"object","description":"Additional metadata for the event"},"createdAt":{"format":"date-time","type":"string","description":"Date and time when the event was created"},"updatedAt":{"format":"date-time","type":"string","description":"Date and time when the event was last updated"}},"required":["id","title","startDateTime","endDateTime","status","visibility","createdAt","updatedAt"]},"PublicApiCalendarEventConferencingDto":{"type":"object","properties":{"provider":{"type":"string","description":"Conferencing provider"},"details":{"type":"object","properties":{"url":{"type":"string"}}}},"required":["details"]}}}}
```

## Delete calendar event

> Delete a calendar event by its ID

```json
{"openapi":"3.0.0","info":{"title":"Salescaling API","version":"1.0"},"tags":[{"name":"Calendar Events","description":"Operations related to calendar events"}],"servers":[{"url":"https://api.salescaling.com","description":"Base API URL"}],"security":[{},{"bearer":[]}],"paths":{"/api/v1/calendar-events/{id}":{"delete":{"operationId":"PublicApiCalendarEventController_deleteCalendarEvent","summary":"Delete calendar event","description":"Delete a calendar event by its ID","parameters":[{"name":"id","required":true,"in":"path","description":"Calendar event ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Calendar event deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiDeleteCalendarEventResponseDto"}}}},"401":{"description":"Unauthorized - missing or invalid API key or Bearer token"}},"tags":["Calendar Events"]}}},"components":{"schemas":{"PublicApiDeleteCalendarEventResponseDto":{"type":"object","properties":{"statusCode":{"type":"number","default":200},"count":{"type":"number"},"error":{"type":"string","nullable":true},"data":{"type":"boolean"}},"required":["statusCode","count","error","data"]}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.salescaling.com/api/calendar-events.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.