← Google Calendar

List Events with Google Calendar API

Pipedream makes it easy to connect APIs for Google Calendar and 1000+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
List Events with the Google Calendar API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜

Trusted by 500,000+ developers from startups to Fortune 500 companies

Adyen logo
Brex logo
Carta logo
Checkr logo
Chameleon logo
DevRev logo
LinkedIn logo
Netflix logo
New Relic logo
OnDeck logo
Replicated logo
Scale AI logo
Teamwork logo
Warner Bros. logo
Xendit logo

Developers Pipedream

Getting Started

Create a workflow to List Events with the Google Calendar API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the List Events action
    1. Connect your Google Calendar account
    2. Select a Calendar ID
    3. Optional- Configure iCal UID
    4. Optional- Configure Max attendees
    5. Optional- Configure Max results
    6. Optional- Select a Order by
    7. Optional- Configure Page token
    8. Optional- Configure Private extended property
    9. Optional- Configure Query
    10. Optional- Configure Shared extended property
    11. Optional- Configure Show deleted
    12. Optional- Configure Show hidden invitations
    13. Optional- Configure Single events
    14. Optional- Configure Sync token
    15. Optional- Configure Max start time
    16. Optional- Configure Minimum end time
    17. Optional- Select a Time zone
    18. Optional- Configure Minimum updated time
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

List Events with Google Calendar API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Google Calendar
 
Try it
List Events with Google Calendar API on New Item in Feed from RSS API
RSS + Google Calendar
 
Try it
List Events with Google Calendar API on New Message in Channel from Discord Bot API
Discord Bot + Google Calendar
 
Try it
List Events with Google Calendar API on New Submission from Typeform API
Typeform + Google Calendar
 
Try it
List Events with Google Calendar API on Custom Events from Zoom API
Zoom + Google Calendar
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

List Events on Google Calendar
Description:Retrieve a list of event from the Google Calendar. [See the docs here](https://developers.google.com/calendar/api/v3/reference/events/list)
Version:0.0.1
Key:google_calendar-list-events

Code

import googleCalendar from "../../google_calendar.app.mjs";

export default {
  key: "google_calendar-list-events",
  name: "List Events",
  description: "Retrieve a list of event from the Google Calendar. [See the docs here](https://developers.google.com/calendar/api/v3/reference/events/list)",
  version: "0.0.1",
  type: "action",
  props: {
    googleCalendar,
    calendarId: {
      propDefinition: [
        googleCalendar,
        "calendarId",
      ],
    },
    iCalUID: {
      propDefinition: [
        googleCalendar,
        "iCalUID",
      ],
    },
    maxAttendees: {
      propDefinition: [
        googleCalendar,
        "maxAttendees",
      ],
    },
    maxResults: {
      propDefinition: [
        googleCalendar,
        "maxResults",
      ],
    },
    orderBy: {
      propDefinition: [
        googleCalendar,
        "orderBy",
      ],
      default: "",
    },
    pageToken: {
      propDefinition: [
        googleCalendar,
        "pageToken",
      ],
    },
    privateExtendedProperty: {
      propDefinition: [
        googleCalendar,
        "privateExtendedProperty",
      ],
    },
    q: {
      propDefinition: [
        googleCalendar,
        "q",
      ],
    },
    sharedExtendedProperty: {
      propDefinition: [
        googleCalendar,
        "sharedExtendedProperty",
      ],
    },
    showDeleted: {
      propDefinition: [
        googleCalendar,
        "showDeleted",
      ],
    },
    showHiddenInvitations: {
      propDefinition: [
        googleCalendar,
        "showHiddenInvitations",
      ],
    },
    singleEvents: {
      propDefinition: [
        googleCalendar,
        "singleEvents",
      ],
    },
    syncToken: {
      propDefinition: [
        googleCalendar,
        "syncToken",
      ],
    },
    timeMax: {
      propDefinition: [
        googleCalendar,
        "timeMax",
      ],
    },
    timeMin: {
      propDefinition: [
        googleCalendar,
        "timeMin",
      ],
    },
    timeZone: {
      propDefinition: [
        googleCalendar,
        "timeZone",
      ],
    },
    updatedMin: {
      propDefinition: [
        googleCalendar,
        "updatedMin",
      ],
    },
  },
  methods: {
    filterEmptyValues(obj) {
      if (!obj) {
        return obj;
      }
      return Object.entries(obj)
        .reduce((reduction,
          [
            key,
            value,
          ]) => {
          if (value === undefined || value === null) {
            return reduction;
          }
          return {
            ...reduction,
            [key]: value,
          };
        }, {});
    },
  },
  async run({ $ }) {
    const args = this.filterEmptyValues({
      calendarId: this.calendarId,
      iCalUID: this.iCalUID,
      maxAttendees: this.maxAttendees,
      maxResults: this.maxResults,
      orderBy: this.orderBy || undefined,
      pageToken: this.pageToken,
      privateExtendedProperty: this.privateExtendedProperty,
      q: this.q,
      sharedExtendedProperty: this.sharedExtendedProperty,
      showDeleted: this.showDeleted,
      showHiddenInvitations: this.showHiddenInvitations,
      singleEvents: this.singleEvents,
      syncToken: this.syncToken,
      timeMax: this.timeMax,
      timeMin: this.timeMin,
      timeZone: this.timeZone,
      updatedMin: this.updatedMin,
    });
    const response = await this.googleCalendar.listEvents(args);

    $.export("$summary", `Successfully retrieved ${response.items.length} event(s)`);

    return response;
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
Google CalendargoogleCalendarappThis component uses the Google Calendar app.
Calendar IDcalendarIdstringSelect a value from the drop down menu.
iCal UIDiCalUIDstring

Specifies event ID in the iCalendar format to be included in the response. Optional.

Max attendeesmaxAttendeesinteger

The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

Max resultsmaxResultsinteger

Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.

Order byorderBystringSelect a value from the drop down menu:{ "label": "startTime", "value": "startTime" }{ "label": "updated", "value": "updated" }
Page tokenpageTokenstring

Token specifying which result page to return. Optional.

Private extended propertyprivateExtendedPropertystring

Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.

Queryqstring

Free text search terms to find events that match these terms in any field, except for extended properties. Optional.

Shared extended propertysharedExtendedPropertystring

Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.

Show deletedshowDeletedboolean

Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.

Show hidden invitationsshowHiddenInvitationsboolean

Whether to include hidden invitations in the result. Optional. The default is False.

Single eventssingleEventsboolean

Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.

Sync tokensyncTokenstring

Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.

Max start timetimeMaxstring

Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.

Minimum end timetimeMinstring

Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.

Time zonetimeZonestringSelect a value from the drop down menu.
Minimum updated timeupdatedMinstring

Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.

Authentication

Google Calendar uses OAuth authentication. When you connect your Google Calendar account, Pipedream will open a popup window where you can sign into Google Calendar and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Google Calendar API.

Pipedream requests the following authorization scopes when you connect your account:

emailprofilehttps://www.googleapis.com/auth/calendar.eventshttps://www.googleapis.com/auth/calendar.readonlyhttps://www.googleapis.com/auth/calendar.settings.readonly

About Google Calendar

Scheduling calendar service developed by Google

More Ways to Use Google Calendar

Triggers

Event Start from the Google Calendar API

Emits a specified time before an event starts

 
Try it
Upcoming Event Alert from the Google Calendar API

Triggers based on a time interval before an upcoming event in the calendar. This source uses Pipedream's Task Scheduler. See here for more information and instructions for connecting your Pipedream account.

 
Try it
New or Updated Event (Instant) from the Google Calendar API

Emit new calendar events when an event is created or updated (does not emit cancelled events)

 
Try it
New Event from the Google Calendar API

Emits when an event is created

 
Try it
Event Search from the Google Calendar API

Emit when an event is created that matches a search

 
Try it

Actions

Add Quick Event with the Google Calendar API

Create an event to the Google Calendar. See the docs here

 
Try it
Create Event with the Google Calendar API

Create an event to the Google Calendar. See the docs here

 
Try it
Delete an Event with the Google Calendar API

Delete an event to the Google Calendar. See the docs here

 
Try it
List calendars from user account with the Google Calendar API

Retrieve calendars from the user account. See the docs here

 
Try it
Retrieve Calendar Details with the Google Calendar API

Retrieve Calendar details of a Google Calendar. See the docs here

 
Try it