Skip to main content

List calendar events

GET 
/v2/calendar/events

Returns all calendar events, paginated and filtered by the date.

Request​

Query Parameters

    per_page integer

    How many records to show per page in the range [1, 100]. Defaults to 25

    page integer

    The current page to fetch results from. Defaults to 1

    include_paging_counts boolean

    Whether to include total_pages and total_count in the metadata. Defaults to false

    sort_by string

    Key to sort on, must be one of: start_time. Defaults to start_time

    sort_direction string

    Direction to sort in, must be one of: ASC, DESC. Defaults to DESC

    start_time string

    Lower bound (inclusive) for a calendar event's end time to filter by. Must be in ISO 8601 format.

    Example: 2022-02-14T10:12:59+00:00.

    end_time string

    Upper bound (exclusive) for a calendar event's start time to filter by. Must be in ISO 8601 format.

    Example: 2022-02-14T10:12:59+00:00.

    user_guid string

    user_guid of the user who created or included as a guest to the event.

Responses​

Success

Schema
  • Array [
    • user_guid string

    User GUID of the user calendar.

    updated_at date-time

    Last modification time of the calendar event.

    title string

    Title of the calendar event

    tenant_id integer

    Tenant ID of the user calendar

    status string

    The status of the calendar event. It can be empty for non-google events.

    start_time date-time

    The (inclusive) start time of the calendar event.

    recurring_interval string

    Specifies how often a recurring event repeats (Daily, Weekly, Monthly, Yearly). This field is omitted for single events or instances of recurring events.

    recurring boolean

    Whether the calendar event is a recurring event.

    recurrence string[]

    List of RRULE for a recurring event, as specified in RFC5545. This field is omitted for single events or instances of recurring events.

    provider string

    The provider of the calendar event.

    organizer string

    The organizer email of the calendar event.

    location string

    Location of the calendar event

    last_occurrence_at date-time

    The timestamp of the last occurrence in a series of recurring events.

    id string

    The calendar event original ID from calendar provider

    i_cal_uid string

    Calendar event unique identifier (iCalUID)

    html_link string

    An absolute link to this calendar event in the Google Calendar Web UI.

    extended_properties object

    Extended properties of the calendar event.

    end_time date-time

    The (exclusive) end time of the calendar event.

    description string

    Description of the calendar event

    creator string

    The creator email of the calendar event.

    created_at date-time

    Creation time of the calendar event.

    conference_data object

    The conference-related information, such as details of a Google Meet conference.

    canceled_at date-time

    The canceled date of the calendar event.

    calendar_id string

    Calendar ID of the user calendar.

    busy boolean

    Busy/free status of the calendar event

    body_html string

    Raw body content from Microsoft calendar events

    attendees object[]

    The attendees of the calendar event.

  • Array [
  • ]
    • all_day boolean

    Whether the calendar event is an all-day event.

  • ]
Loading...