Retrieve Free/Busy Calendar Details with Google Calendar API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Retrieve Free/Busy Calendar Details with the Google Calendar API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

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

Configure the Retrieve Free/Busy Calendar Details action
1. Connect your Google Calendar account
2. Select a Calendar ID
3. Configure Min time
4. Configure Max Time
5. Optional- Select a Time Zone
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Retreive Free/Busy Calendar Details with Google Calendar API on New Submission from Typeform API

Typeform + Google Calendar

Try it

Retrieve Free/Busy Calendar Details with Google Calendar API on New Created Project from Roll API

Roll + Google Calendar

Try it

Retrieve Free/Busy Calendar Details with Google Calendar API on New Status Boosted from Mastodon API

Mastodon + Google Calendar

Try it

Retreive Free/Busy Calendar Details with Google Calendar API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Google Calendar

Try it

Retreive Free/Busy Calendar Details with Google Calendar API on New Item in Feed from RSS API

RSS + 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.

Retrieve Free/Busy Calendar Details on Google Calendar

Description:Retrieve free/busy calendar details from Google Calendar. [See the documentation](https://googleapis.dev/nodejs/googleapis/latest/calendar/classes/Resource$Freebusy.html#query)

Version:0.1.7

Key:google_calendar-query-free-busy-calendars

View on GitHub

Code#

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

export default {
  key: "google_calendar-query-free-busy-calendars",
  name: "Retrieve Free/Busy Calendar Details",
  description: "Retrieve free/busy calendar details from Google Calendar. [See the documentation](https://googleapis.dev/nodejs/googleapis/latest/calendar/classes/Resource$Freebusy.html#query)",
  version: "0.1.7",
  type: "action",
  props: {
    googleCalendar,
    calendarId: {
      propDefinition: [
        googleCalendar,
        "calendarId",
      ],
      optional: false,
      description: "Select a calendar to retrieve free/busy details",
    },
    timeMin: {
      propDefinition: [
        googleCalendar,
        "timeMin",
      ],
      optional: false,
    },
    timeMax: {
      propDefinition: [
        googleCalendar,
        "timeMax",
      ],
      optional: false,
    },
    timeZone: {
      propDefinition: [
        googleCalendar,
        "timeZone",
      ],
      description: "Specify the preferred time zone to be used on the response",
    },
  },
  async run({ $ }) {
    const response = await this.googleCalendar.queryFreeBusy({
      requestBody: {
        timeMin: this.timeMin,
        timeMax: this.timeMax,
        timeZone: this.timeZone,
        items: [
          {
            id: this.calendarId,
          },
        ],
      },
    });

    $.export("$summary", `Successfully retrieved free/busy calendar details from ${this.timeMin} to ${this.timeMax}`);

    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.

Label	Prop	Type	Description
Google Calendar	`googleCalendar`	`app`	This component uses the Google Calendar app.
Calendar ID	`calendarId`	`string`	Select a value from the drop down menu.
Min time	`timeMin`	`string`	Lower bound (exclusive) for an event's time to filter by. 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. Must be smaller than Max Time.
Max Time	`timeMax`	`string`	Upper bound (exclusive) for an event's time to filter by. 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. Must be greater than Min Time.
Time Zone	`timeZone`	`string`	Select a value from the drop down menu.

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:

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