Calendars

Operations related to calendars

Get calendars

get

Retrieve a paginated list of calendars with optional filtering

Authorizations

x-api-key

x-api-keystringRequired

Query parameters

namestringOptional

Filter calendars by name (partial match)

Example: My Calendar

isPrimarybooleanOptional

Filter calendars by primary status

Example: true

readOnlybooleanOptional

Filter calendars by read-only status

Example: false

pagestringOptional

Page number for pagination

Example: 1

limitstringOptional

Number of items per page

Example: 10

Responses

200

Calendars retrieved successfully

application/json

401

Unauthorized - missing or invalid API key

get

/api/v1/calendars

HTTPcURLJavaScriptPython

GET /api/v1/calendars 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",
      "name": "My Calendar",
      "description": "My personal calendar for work events",
      "hexColor": "#4285f4",
      "hexForegroundColor": "#ffffff",
      "isPrimary": false,
      "location": "New York, NY",
      "timezone": "America/New_York",
      "readOnly": false,
      "metadata": {
        "customField": "value"
      },
      "createdAt": "2024-07-15T09:00:00.000Z",
      "updatedAt": "2024-07-15T09:30:00.000Z"
    }
  ]
}

Create calendar

post

Create a new calendar

Authorizations

x-api-key

x-api-keystringRequired

Body

application/json

namestringRequired

Name of the calendar

Example: My Calendar

descriptionstringOptional

Description of the calendar

Example: My personal calendar for work events

hexColorstringOptional

Hex color code for the calendar

Example: #4285f4

hexForegroundColorstringOptional

Hex foreground color code for the calendar

Example: #ffffff

isPrimarybooleanOptional

Whether this is the primary calendar

Example: false

locationstringOptional

Location associated with the calendar

Example: New York, NY

timezonestringOptional

IANA time zone database formatted string

Example: America/New_York

readOnlybooleanOptional

Whether the calendar is read-only

Example: false

metadataobjectOptional

Additional metadata for the calendar

Example: {"customField":"value"}

Responses

201

Calendar created successfully

application/json

401

Unauthorized - missing or invalid API key

post

/api/v1/calendars

HTTPcURLJavaScriptPython

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

{
  "name": "My Calendar",
  "description": "My personal calendar for work events",
  "hexColor": "#4285f4",
  "hexForegroundColor": "#ffffff",
  "isPrimary": false,
  "location": "New York, NY",
  "timezone": "America/New_York",
  "readOnly": false,
  "metadata": {
    "customField": "value"
  }
}

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": {
    "id": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "name": "My Calendar",
    "description": "My personal calendar for work events",
    "hexColor": "#4285f4",
    "hexForegroundColor": "#ffffff",
    "isPrimary": false,
    "location": "New York, NY",
    "timezone": "America/New_York",
    "readOnly": false,
    "metadata": {
      "customField": "value"
    },
    "createdAt": "2024-07-15T09:00:00.000Z",
    "updatedAt": "2024-07-15T09:30:00.000Z"
  }
}

Get calendar by ID

get

Retrieve a specific calendar by its ID

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Calendar ID

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

Responses

200

Calendar retrieved successfully

application/json

401

Unauthorized - missing or invalid API key

get

/api/v1/calendars/{id}

HTTPcURLJavaScriptPython

GET /api/v1/calendars/{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",
    "name": "My Calendar",
    "description": "My personal calendar for work events",
    "hexColor": "#4285f4",
    "hexForegroundColor": "#ffffff",
    "isPrimary": false,
    "location": "New York, NY",
    "timezone": "America/New_York",
    "readOnly": false,
    "metadata": {
      "customField": "value"
    },
    "createdAt": "2024-07-15T09:00:00.000Z",
    "updatedAt": "2024-07-15T09:30:00.000Z"
  }
}

Update calendar

put

Update an existing calendar

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Calendar ID

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

Body

application/json

namestringOptional

Name of the calendar

Example: My Updated Calendar

descriptionstringOptional

Description of the calendar

Example: My updated personal calendar for work events

hexColorstringOptional

Hex color code for the calendar

Example: #4285f4

hexForegroundColorstringOptional

Hex foreground color code for the calendar

Example: #ffffff

isPrimarybooleanOptional

Whether this is the primary calendar

Example: false

locationstringOptional

Location associated with the calendar

Example: New York, NY

timezonestringOptional

IANA time zone database formatted string

Example: America/New_York

readOnlybooleanOptional

Whether the calendar is read-only

Example: false

metadataobjectOptional

Additional metadata for the calendar

Example: {"customField":"value"}

Responses

200

Calendar updated successfully

application/json

401

Unauthorized - missing or invalid API key

put

/api/v1/calendars/{id}

HTTPcURLJavaScriptPython

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

{
  "name": "My Updated Calendar",
  "description": "My updated personal calendar for work events",
  "hexColor": "#4285f4",
  "hexForegroundColor": "#ffffff",
  "isPrimary": false,
  "location": "New York, NY",
  "timezone": "America/New_York",
  "readOnly": false,
  "metadata": {
    "customField": "value"
  }
}

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": {
    "id": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "name": "My Calendar",
    "description": "My personal calendar for work events",
    "hexColor": "#4285f4",
    "hexForegroundColor": "#ffffff",
    "isPrimary": false,
    "location": "New York, NY",
    "timezone": "America/New_York",
    "readOnly": false,
    "metadata": {
      "customField": "value"
    },
    "createdAt": "2024-07-15T09:00:00.000Z",
    "updatedAt": "2024-07-15T09:30:00.000Z"
  }
}

Delete calendar

delete

Delete a calendar by its ID

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Calendar ID

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

Responses

200

Calendar deleted successfully

application/json

401

Unauthorized - missing or invalid API key

delete

/api/v1/calendars/{id}

HTTPcURLJavaScriptPython

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

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