Calendar

List calendar events

Returns upcoming calendar events from the authenticated user's connected calendars, with pagination and a configurable time window.

get/calendar/events

Request

  • Base URL: https://circleback.ai/api
  • URL: https://circleback.ai/api/calendar/events
  • Auth: HTTP bearer

Query parameters

cursorstring

Cursor for the next page. Omit for the first page (RFC 8288).

includeOfflineSingleAttendeeboolean

Set to true to include calendar meetings that have no meeting link and only one attendee.

startTimeLookbackHoursnumber

How many hours in the past to include calendar meetings from, based on their start time.

startTimeLookaheadHoursnumber

How many hours in the future to include calendar meetings from, based on their start time.

sortDirection'ascending' | 'descending'

The direction calendar meetings are sorted in by start time. Defaults to ascending.

Response

Successful response.

idstring required

The unique identifier of the calendar meeting.

titlestring required

The title of the calendar meeting.

icalUidstring required

The iCalendar UID of the calendar event.

calendarDescriptionstring

The description of the calendar event.

calendarPlatformstring required

The calendar platform the meeting was synced from.

endTimestring required

When the calendar meeting ends, as an ISO 8601 timestamp.

isExternalboolean required

Whether the meeting includes attendees from more than one email domain.

isHostedByMeboolean required

Whether the current user organized the calendar meeting.

locationstring

The location of the calendar meeting.

meetingIdstring

The Circleback meeting associated with the calendar meeting, when one exists.

meetingPlatformstring nullable required

The conferencing platform hosting the meeting, when detected.

organizerEmailstring nullable required

The email address of the meeting organizer.

overrideShouldRecordboolean nullable required

Whether the user manually overrode the automatic recording decision, or null when no override is set.

platformstring nullable required

The conferencing platform hosting the meeting, when detected. Alias of meetingPlatform.

recurringEventIdstring

The identifier of the recurring event series the meeting belongs to.

startTimestring required

When the calendar meeting starts, as an ISO 8601 timestamp.

willRecordboolean required

Whether the notetaker will join and record the meeting.

willRecordReasonstring required

A human-readable explanation of why the meeting will or will not be recorded.

Example response

[
  {
    "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"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.