Calendar Events

Operations related to calendar events

Get calendar events

get

Retrieve a paginated list of calendar events with optional filtering

Authorizations

x-api-key

x-api-keystringRequired

Query parameters

startDatestringOptional

Filter calendar events by start date

Example: 2025-01-01

endDatestringOptional

Filter calendar events by end date

Example: 2025-01-01

calendarIdstringOptional

Filter calendar events by calendar ID

Example: 5516cd47-2bd0-4f4f-adc2-22524e54ba4d

statusstringOptional

Filter calendar events by status

Example: confirmed

pagestringOptional

Page number

Example: 1

limitstringOptional

Number of items per page

Example: 10

Responses

200

Calendar events retrieved successfully

application/json

401

Unauthorized - missing or invalid API key

get

/api/v1/calendar-events

HTTPcURLJavaScriptPython

GET /api/v1/calendar-events HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": [
    {
      "id": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
      "calendarId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
      "title": "Team Meeting",
      "description": "Weekly team standup meeting",
      "startDateTime": "2024-07-15T10:00:00.000Z",
      "endDateTime": "2024-07-15T11:00:00.000Z",
      "location": "Conference Room A",
      "status": "confirmed",
      "visibility": "default",
      "organizerEmail": "[email protected]",
      "organizerName": "John Doe",
      "busy": true,
      "readOnly": false,
      "hideParticipants": false,
      "htmlLink": "https://calendar.google.com/event?eid=...",
      "iCalUID": "[email protected]",
      "nylasId": "nylas_event_123",
      "masterEventId": "master_event_123",
      "duration": 3600,
      "recurrence": [
        "FREQ=WEEKLY;BYDAY=MO"
      ],
      "participants": [
        {
          "email": "[email protected]",
          "name": "John Doe",
          "status": "yes"
        }
      ],
      "conferencing": {
        "provider": "Zoom Meeting",
        "details": {
          "url": "https://zoom.us/j/91288944390?pwd=1234567890"
        }
      },
      "metadata": {
        "customField": "value"
      },
      "createdAt": "2024-07-15T09:00:00.000Z",
      "updatedAt": "2024-07-15T09:30:00.000Z"
    }
  ]
}

Create calendar event

post

Create a new calendar event

Authorizations

x-api-key

x-api-keystringRequired

Body

application/json

calendarIdstringRequired

Calendar ID this event belongs to

Example: 5516cd47-2bd0-4f4f-adc2-22524e54ba4d

titlestringRequired

Title of the calendar event

Example: Team Meeting

descriptionstringOptional

Description of the calendar event

Example: Weekly team standup meeting

startDateTimestring · date-timeRequired

Date and time when the event starts

Example: 2024-07-15T10:00:00.000Z

endDateTimestring · date-timeRequired

Date and time when the event ends

Example: 2024-07-15T11:00:00.000Z

locationstringOptional

Location of the event

Example: Conference Room A

statusstring · enumOptional

Status of the calendar event

Example: confirmedPossible values:

visibilitystring · enumOptional

Visibility of the calendar event

Example: defaultPossible values:

organizerEmailstringOptional

Email of the event organizer

Example: [email protected]

organizerNamestringOptional

Name of the event organizer

Example: John Doe

busybooleanOptional

Whether the event is marked as busy

Example: true

readOnlybooleanOptional

Whether the event is read-only

Example: false

hideParticipantsbooleanOptional

Whether to hide participants

Example: false

durationnumberOptional

Duration of the event in seconds

Example: 3600

recurrencestring[]Optional

Recurrence rules for the event

Example: ["FREQ=WEEKLY;BYDAY=MO"]

meetingUrlstringOptional

Meeting URL

Example: https://zoom.us/j/91288944390?pwd=1234567890

metadataobjectOptional

Additional metadata for the event

Example: {"customField":"value"}

Responses

201

Calendar event created successfully

application/json

401

Unauthorized - missing or invalid API key

post

/api/v1/calendar-events

HTTPcURLJavaScriptPython

POST /api/v1/calendar-events HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 633

{
  "calendarId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
  "title": "Team Meeting",
  "description": "Weekly team standup meeting",
  "startDateTime": "2024-07-15T10:00:00.000Z",
  "endDateTime": "2024-07-15T11:00:00.000Z",
  "location": "Conference Room A",
  "status": "confirmed",
  "visibility": "default",
  "organizerEmail": "[email protected]",
  "organizerName": "John Doe",
  "busy": true,
  "readOnly": false,
  "hideParticipants": false,
  "duration": 3600,
  "recurrence": [
    "FREQ=WEEKLY;BYDAY=MO"
  ],
  "participants": [
    {
      "email": "[email protected]",
      "name": "John Doe",
      "status": "yes"
    }
  ],
  "meetingUrl": "https://zoom.us/j/91288944390?pwd=1234567890",
  "metadata": {
    "customField": "value"
  }
}

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": {
    "id": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "calendarId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "title": "Team Meeting",
    "description": "Weekly team standup meeting",
    "startDateTime": "2024-07-15T10:00:00.000Z",
    "endDateTime": "2024-07-15T11:00:00.000Z",
    "location": "Conference Room A",
    "status": "confirmed",
    "visibility": "default",
    "organizerEmail": "[email protected]",
    "organizerName": "John Doe",
    "busy": true,
    "readOnly": false,
    "hideParticipants": false,
    "htmlLink": "https://calendar.google.com/event?eid=...",
    "iCalUID": "[email protected]",
    "nylasId": "nylas_event_123",
    "masterEventId": "master_event_123",
    "duration": 3600,
    "recurrence": [
      "FREQ=WEEKLY;BYDAY=MO"
    ],
    "participants": [
      {
        "email": "[email protected]",
        "name": "John Doe",
        "status": "yes"
      }
    ],
    "conferencing": {
      "provider": "Zoom Meeting",
      "details": {
        "url": "https://zoom.us/j/91288944390?pwd=1234567890"
      }
    },
    "metadata": {
      "customField": "value"
    },
    "createdAt": "2024-07-15T09:00:00.000Z",
    "updatedAt": "2024-07-15T09:30:00.000Z"
  }
}

Get calendar event by ID

get

Retrieve a specific calendar event by its ID

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Calendar event ID

Example: 5516cd47-2bd0-4f4f-adc2-22524e54ba4d

Responses

200

Calendar event retrieved successfully

application/json

401

Unauthorized - missing or invalid API key

get

/api/v1/calendar-events/{id}

HTTPcURLJavaScriptPython

GET /api/v1/calendar-events/{id} HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": {
    "id": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "calendarId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "title": "Team Meeting",
    "description": "Weekly team standup meeting",
    "startDateTime": "2024-07-15T10:00:00.000Z",
    "endDateTime": "2024-07-15T11:00:00.000Z",
    "location": "Conference Room A",
    "status": "confirmed",
    "visibility": "default",
    "organizerEmail": "[email protected]",
    "organizerName": "John Doe",
    "busy": true,
    "readOnly": false,
    "hideParticipants": false,
    "htmlLink": "https://calendar.google.com/event?eid=...",
    "iCalUID": "[email protected]",
    "nylasId": "nylas_event_123",
    "masterEventId": "master_event_123",
    "duration": 3600,
    "recurrence": [
      "FREQ=WEEKLY;BYDAY=MO"
    ],
    "participants": [
      {
        "email": "[email protected]",
        "name": "John Doe",
        "status": "yes"
      }
    ],
    "conferencing": {
      "provider": "Zoom Meeting",
      "details": {
        "url": "https://zoom.us/j/91288944390?pwd=1234567890"
      }
    },
    "metadata": {
      "customField": "value"
    },
    "createdAt": "2024-07-15T09:00:00.000Z",
    "updatedAt": "2024-07-15T09:30:00.000Z"
  }
}

Update calendar event

put

Update an existing calendar event

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Calendar event ID

Example: 5516cd47-2bd0-4f4f-adc2-22524e54ba4d

Body

application/json

titlestringOptional

Title of the calendar event

Example: Team Meeting

descriptionstringOptional

Description of the calendar event

Example: Weekly team standup meeting

startDateTimestring · date-timeOptional

Date and time when the event starts

Example: 2024-07-15T10:00:00.000Z

endDateTimestring · date-timeOptional

Date and time when the event ends

Example: 2024-07-15T11:00:00.000Z

locationstringOptional

Location of the event

Example: Conference Room A

statusstring · enumOptional

Status of the calendar event

Example: confirmedPossible values:

visibilitystring · enumOptional

Visibility of the calendar event

Example: defaultPossible values:

organizerEmailstringOptional

Email of the event organizer

Example: [email protected]

organizerNamestringOptional

Name of the event organizer

Example: John Doe

busybooleanOptional

Whether the event is marked as busy

Example: true

readOnlybooleanOptional

Whether the event is read-only

Example: false

hideParticipantsbooleanOptional

Whether to hide participants

Example: false

durationnumberOptional

Duration of the event in seconds

Example: 3600

recurrencestring[]Optional

Recurrence rules for the event

Example: ["FREQ=WEEKLY;BYDAY=MO"]

meetingUrlstringOptional

Meeting URL

Example: https://zoom.us/j/91288944390?pwd=1234567890

metadataobjectOptional

Additional metadata for the event

Example: {"customField":"value"}

Responses

200

Calendar event updated successfully

application/json

401

Unauthorized - missing or invalid API key

put

/api/v1/calendar-events/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/calendar-events/{id} HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 581

{
  "title": "Team Meeting",
  "description": "Weekly team standup meeting",
  "startDateTime": "2024-07-15T10:00:00.000Z",
  "endDateTime": "2024-07-15T11:00:00.000Z",
  "location": "Conference Room A",
  "status": "confirmed",
  "visibility": "default",
  "organizerEmail": "[email protected]",
  "organizerName": "John Doe",
  "busy": true,
  "readOnly": false,
  "hideParticipants": false,
  "duration": 3600,
  "recurrence": [
    "FREQ=WEEKLY;BYDAY=MO"
  ],
  "participants": [
    {
      "email": "[email protected]",
      "name": "John Doe",
      "status": "yes"
    }
  ],
  "meetingUrl": "https://zoom.us/j/91288944390?pwd=1234567890",
  "metadata": {
    "customField": "value"
  }
}

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": {
    "id": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "calendarId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "title": "Team Meeting",
    "description": "Weekly team standup meeting",
    "startDateTime": "2024-07-15T10:00:00.000Z",
    "endDateTime": "2024-07-15T11:00:00.000Z",
    "location": "Conference Room A",
    "status": "confirmed",
    "visibility": "default",
    "organizerEmail": "[email protected]",
    "organizerName": "John Doe",
    "busy": true,
    "readOnly": false,
    "hideParticipants": false,
    "htmlLink": "https://calendar.google.com/event?eid=...",
    "iCalUID": "[email protected]",
    "nylasId": "nylas_event_123",
    "masterEventId": "master_event_123",
    "duration": 3600,
    "recurrence": [
      "FREQ=WEEKLY;BYDAY=MO"
    ],
    "participants": [
      {
        "email": "[email protected]",
        "name": "John Doe",
        "status": "yes"
      }
    ],
    "conferencing": {
      "provider": "Zoom Meeting",
      "details": {
        "url": "https://zoom.us/j/91288944390?pwd=1234567890"
      }
    },
    "metadata": {
      "customField": "value"
    },
    "createdAt": "2024-07-15T09:00:00.000Z",
    "updatedAt": "2024-07-15T09:30:00.000Z"
  }
}

Delete calendar event

delete

Delete a calendar event by its ID

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Calendar event ID

Example: 5516cd47-2bd0-4f4f-adc2-22524e54ba4d

Responses

200

Calendar event deleted successfully

application/json

401

Unauthorized - missing or invalid API key

delete

/api/v1/calendar-events/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/calendar-events/{id} HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": true
}