# List calendar events (/docs/api/calendar/list-calendar-events)

## OpenAPI

```json
{
  "info": {
    "description": "The Circleback public REST API provides programmatic access to your meetings, notes, action items, transcripts, and more. Authenticate every request by sending your API key as a bearer token.",
    "title": "Circleback Public API",
    "version": "1.0.0"
  },
  "openapi": "3.2.0",
  "servers": [
    {
      "url": "https://circleback.ai/api"
    }
  ],
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "bearerFormat": "cb_<secret>",
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "tags": [
    {
      "description": "View upcoming calendar events and control whether Circleback joins them.",
      "name": "Calendar"
    }
  ],
  "paths": {
    "/calendar/events": {
      "get": {
        "description": "Returns upcoming calendar events from the authenticated user's connected calendars, with pagination and a configurable time window.",
        "parameters": [
          {
            "description": "Set to true to include calendar meetings that have no meeting link and only one attendee.",
            "in": "query",
            "name": "includeOfflineSingleAttendee",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "description": "How many hours in the past to include calendar meetings from, based on their start time.",
            "in": "query",
            "name": "startTimeLookbackHours",
            "required": false,
            "schema": {
              "type": "number"
            }
          },
          {
            "description": "How many hours in the future to include calendar meetings from, based on their start time.",
            "in": "query",
            "name": "startTimeLookaheadHours",
            "required": false,
            "schema": {
              "type": "number"
            }
          },
          {
            "description": "The direction calendar meetings are sorted in by start time. Defaults to ascending.",
            "in": "query",
            "name": "sortDirection",
            "required": false,
            "schema": {
              "enum": [
                "ascending",
                "descending"
              ],
              "type": "string"
            }
          },
          {
            "description": "Cursor for the next page. Omit for the first page (RFC 8288).",
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "additionalProperties": false,
                    "example": {
                      "id": "google-calendar-event-id",
                      "title": "Event Venue Review",
                      "icalUid": "event-venue-review@google.com",
                      "attendees": [
                        {
                          "name": "John Appleseed",
                          "email": "john@initech.com",
                          "isOrganizer": true,
                          "status": "accepted"
                        },
                        {
                          "name": "Samantha Grey",
                          "email": "samantha@initech.com",
                          "isOrganizer": false,
                          "status": "accepted"
                        }
                      ],
                      "calendarDescription": "Quarterly venue review",
                      "calendarPlatform": "google_calendar",
                      "endTime": "2023-07-25T20:30:00.000Z",
                      "isExternal": false,
                      "isHostedByMe": true,
                      "location": "Google Meet",
                      "meetingId": "WRweb12iCBimU6Vo8cD7z",
                      "meetingPlatform": "google_meet",
                      "organizerEmail": "john@initech.com",
                      "overrideShouldRecord": false,
                      "platform": "google_meet",
                      "startTime": "2023-07-25T20:00:00.000Z",
                      "willRecord": true,
                      "willRecordReason": "External attendees"
                    },
                    "properties": {
                      "id": {
                        "description": "The unique identifier of the calendar meeting.",
                        "type": "string"
                      },
                      "title": {
                        "description": "The title of the calendar meeting.",
                        "type": "string"
                      },
                      "icalUid": {
                        "description": "The iCalendar UID of the calendar event.",
                        "type": "string"
                      },
                      "attendees": {
                        "description": "The attendees invited to the calendar meeting.",
                        "items": {
                          "additionalProperties": false,
                          "properties": {
                            "name": {
                              "anyOf": [
                                {
                                  "type": "string"
                                },
                                {
                                  "type": "null"
                                }
                              ],
                              "description": "The name of the attendee."
                            },
                            "email": {
                              "description": "The email address of the attendee.",
                              "type": "string"
                            },
                            "isOrganizer": {
                              "description": "Whether the attendee organized the calendar meeting.",
                              "type": "boolean"
                            },
                            "status": {
                              "description": "The attendee's response to the calendar meeting invitation.",
                              "enum": [
                                "accepted",
                                "declined",
                                "tentative",
                                "not_available"
                              ],
                              "type": "string"
                            }
                          },
                          "type": "object"
                        },
                        "type": "array"
                      },
                      "calendarDescription": {
                        "description": "The description of the calendar event.",
                        "type": "string"
                      },
                      "calendarPlatform": {
                        "description": "The calendar platform the meeting was synced from.",
                        "type": "string"
                      },
                      "endTime": {
                        "description": "When the calendar meeting ends, as an ISO 8601 timestamp.",
                        "type": "string"
                      },
                      "isExternal": {
                        "description": "Whether the meeting includes attendees from more than one email domain.",
                        "type": "boolean"
                      },
                      "isHostedByMe": {
                        "description": "Whether the current user organized the calendar meeting.",
                        "type": "boolean"
                      },
                      "location": {
                        "description": "The location of the calendar meeting.",
                        "type": "string"
                      },
                      "meetingId": {
                        "description": "The Circleback meeting associated with the calendar meeting, when one exists.",
                        "type": "string"
                      },
                      "meetingPlatform": {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "type": "null"
                          }
                        ],
                        "description": "The conferencing platform hosting the meeting, when detected."
                      },
                      "organizerEmail": {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "type": "null"
                          }
                        ],
                        "description": "The email address of the meeting organizer."
                      },
                      "overrideShouldRecord": {
                        "anyOf": [
                          {
                            "type": "boolean"
                          },
                          {
                            "type": "null"
                          }
                        ],
                        "description": "Whether the user manually overrode the automatic recording decision, or null when no override is set."
                      },
                      "platform": {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "type": "null"
                          }
                        ],
                        "description": "The conferencing platform hosting the meeting, when detected. Alias of meetingPlatform."
                      },
                      "recurringEventId": {
                        "description": "The identifier of the recurring event series the meeting belongs to.",
                        "type": "string"
                      },
                      "startTime": {
                        "description": "When the calendar meeting starts, as an ISO 8601 timestamp.",
                        "type": "string"
                      },
                      "willRecord": {
                        "description": "Whether the notetaker will join and record the meeting.",
                        "type": "boolean"
                      },
                      "willRecordReason": {
                        "description": "A human-readable explanation of why the meeting will or will not be recorded.",
                        "type": "string"
                      }
                    },
                    "required": [
                      "id",
                      "overrideShouldRecord",
                      "title",
                      "willRecord",
                      "willRecordReason",
                      "startTime",
                      "endTime",
                      "platform",
                      "meetingPlatform",
                      "calendarPlatform",
                      "isExternal",
                      "isHostedByMe",
                      "organizerEmail",
                      "attendees",
                      "icalUid"
                    ],
                    "type": "object"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Successful response."
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": false,
                  "properties": {
                    "code": {
                      "description": "A machine-readable code identifying the type of failure.",
                      "type": "string"
                    },
                    "error": {
                      "description": "A human-readable message explaining why the request failed.",
                      "type": "string"
                    },
                    "issues": {
                      "description": "The field-level validation issues found in an invalid request.",
                      "items": {
                        "additionalProperties": false,
                        "properties": {
                          "message": {
                            "description": "A human-readable explanation of the validation failure.",
                            "type": "string"
                          },
                          "path": {
                            "description": "The location of the request field that failed validation.",
                            "type": "string"
                          }
                        },
                        "required": [
                          "path",
                          "message"
                        ],
                        "type": "object"
                      },
                      "type": "array"
                    }
                  },
                  "required": [
                    "error"
                  ],
                  "type": "object"
                }
              }
            },
            "description": "The request failed validation."
          }
        },
        "security": [
          {
            "ApiKeyAuth": []
          }
        ],
        "summary": "List calendar events",
        "tags": [
          "Calendar"
        ]
      }
    }
  }
}
```