Calendar.freebusy.query

Returns free/busy information for a set of calendars.

POST/freeBusy

Use it in a workflow

Add a step and choose the Google Calendar connector.
Pick the Calendar.freebusy.query action (under freebusy).
Fill in the fields below, then reference the result from later steps as {{calendarFreebusyQuery.response.data}}.

Request

Query parameters

altstring

Data format for the response.

One ofjson

fieldsstring

Selector specifying which fields to include in a partial response.

keystring

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

oauth_tokenstring

OAuth 2.0 token for the current user.

prettyPrintboolean

Returns response with indentations and line breaks.

quotaUserstring

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIpstring

Deprecated. Please use quotaUser instead.

Request body

Enter the body as JSON in the step's Body field.

calendarExpansionMaxinteger (int32)

Maximal number of calendars for which FreeBusy information is to be provided. Optional. Maximum value is 50.

groupExpansionMaxinteger (int32)

Maximal number of calendar identifiers to be provided for a single group. Optional. An error is returned for a group with more members than this value. Maximum value is 100.

itemsarray<object>

List of calendars and/or groups to query.

idstring

The identifier of a calendar or a group.

timeMaxstring (date-time)

The end of the interval for the query formatted as per RFC3339.

timeMinstring (date-time)

The start of the interval for the query formatted as per RFC3339.

timeZonestring

Time zone used in the response. Optional. The default is UTC.

Default "UTC"

json

{
  "calendarExpansionMax": 0,
  "groupExpansionMax": 0,
  "items": [
    {
      "id": "string"
    }
  ],
  "timeMax": "2025-01-01T00:00:00Z",
  "timeMin": "2025-01-01T00:00:00Z",
  "timeZone": "UTC"
}

Response

Returns 200 with an object. Read it in later steps with {{calendarFreebusyQuery.response.data.<field>}}.

calendarsobject

List of free/busy information for calendars.

groupsobject

Expansion of groups.

kindstring

Type of the resource ("calendar#freeBusy").

Default "calendar#freeBusy"

timeMaxstring (date-time)

The end of the interval.

timeMinstring (date-time)

The start of the interval.

json

{
  "calendars": {},
  "groups": {},
  "kind": "calendar#freeBusy",
  "timeMax": "2025-01-01T00:00:00Z",
  "timeMin": "2025-01-01T00:00:00Z"
}

Need more? See the Google Calendar guide for connection setup and behaviour shared by every action.

Was this page helpful?