---
agentTools:
  projectIndex: https://sched.readme.io/llms.txt
---

# Connected Calendars

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "sched.dev",
    "description": "Scheduling API",
    "version": "v1"
  },
  "servers": [
    {
      "url": "https://api.sched.dev",
      "description": "API Server"
    },
    {
      "url": "https://sandbox-api.sched.dev",
      "description": "Sandbox API Server"
    }
  ],
  "paths": {
    "/v1/connected_calendars": {
      "get": {
        "tags": [
          "Connected Calendars"
        ],
        "summary": "Connected Calendars",
        "operationId": "connected_calendars_v1_connected_calendars_get",
        "parameters": [
          {
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 0,
              "title": "Skip",
              "default": 0
            },
            "name": "skip",
            "in": "query"
          },
          {
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "title": "Limit",
              "default": 50
            },
            "name": "limit",
            "in": "query"
          },
          {
            "required": false,
            "schema": {
              "type": "string",
              "title": "Sort Field",
              "default": "name"
            },
            "name": "sort_field",
            "in": "query"
          },
          {
            "required": false,
            "schema": {
              "type": "string",
              "title": "Sort Order",
              "default": "asc"
            },
            "name": "sort_order",
            "in": "query"
          }
        ],
        "responses": {
          "200": {
            "description": "List all connected_calendar instances",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IGetResponseBase_List_src.schemas.connected_calendar.IConnectedCalendarRead__"
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        },
        "security": [
          {
            "OAuth2ClientCredentialsBearer": [
              "connected_calendars:read"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "HTTPValidationError": {
        "properties": {
          "detail": {
            "items": {
              "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
          }
        },
        "type": "object",
        "title": "HTTPValidationError"
      },
      "IConnectedCalendarRead": {
        "properties": {
          "resource_id": {
            "type": "string",
            "format": "uuid",
            "title": "Resource Id",
            "description": "The ID of the resource"
          },
          "provider": {
            "type": "string",
            "title": "Provider",
            "description": "The calendar provider"
          },
          "refresh_token": {
            "type": "string",
            "title": "Refresh Token",
            "description": "The refresh token for the connected calendar"
          },
          "access_token_meta_data": {
            "type": "object",
            "title": "Access Token Meta Data",
            "default": {}
          },
          "available_calendars": {
            "type": "object",
            "title": "Available Calendars",
            "default": {}
          },
          "email": {
            "type": "string",
            "title": "Email",
            "description": "The email associated with the connected calendar"
          },
          "selected_calendar": {
            "type": "string",
            "title": "Selected Calendar",
            "description": "The ID of the selected calendar"
          },
          "subscribe_to_deleted_appoinment_event": {
            "type": "boolean",
            "title": "Subscribe To Deleted Appoinment Event",
            "description": "Subscribe to deleted appointment events",
            "default": true
          },
          "send_booked_appoinments_to_cal": {
            "type": "boolean",
            "title": "Send Booked Appoinments To Cal",
            "description": "Send booked appointments to calendar",
            "default": true
          },
          "subscription_channel_id": {
            "type": "string",
            "title": "Subscription Channel Id",
            "description": "The ID of the subscription channel"
          },
          "subscription_meta_data": {
            "type": "object",
            "title": "Subscription Meta Data",
            "description": "The metadata of the subscription channel"
          },
          "subscription_channel_expires": {
            "type": "string",
            "format": "date-time",
            "title": "Subscription Channel Expires",
            "description": "The expiration time of the subscription channel"
          },
          "id": {
            "type": "string",
            "format": "uuid",
            "title": "Id"
          }
        },
        "type": "object",
        "required": [
          "resource_id",
          "provider",
          "refresh_token",
          "email",
          "selected_calendar",
          "id"
        ],
        "title": "IConnectedCalendarRead"
      },
      "IGetResponseBase_List_src.schemas.connected_calendar.IConnectedCalendarRead__": {
        "properties": {
          "message": {
            "type": "string",
            "title": "Message",
            "default": "Data got correctly"
          },
          "meta": {
            "type": "object",
            "title": "Meta",
            "default": {}
          },
          "data": {
            "items": {
              "$ref": "#/components/schemas/IConnectedCalendarRead"
            },
            "type": "array",
            "title": "Data"
          }
        },
        "type": "object",
        "title": "IGetResponseBase[List[src.schemas.connected_calendar.IConnectedCalendarRead]]"
      },
      "ValidationError": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      }
    },
    "securitySchemes": {
      "OAuth2ClientCredentialsBearer": {
        "type": "oauth2",
        "flows": {
          "password": {
            "scopes": {},
            "tokenUrl": "/v1/auth/token"
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 103,
      "1": 14,
      "2": 106,
      "3": 94,
      "4": 33,
      "5": 109,
      "6": 146,
      "7": 0,
      "8": 49,
      "9": 64,
      "10": 212,
      "11": 226
    }
  }
}
```