Get free/busy with the Google Calendar API

Returns the busy intervals of one or more calendars between timeMin and timeMax, under calendars, keyed by calendar id. A calendar the user cannot see comes back with errors instead of busy.

Identifier
google_calendar_get_free_busy

The request

POST https://connect.reportei.com/api/tools/google_calendar_get_free_busy/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "timeMin": "<timeMin>",
    "timeMax": "<timeMax>",
    "items": []
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
timeMinstringYesStart of the interval, RFC3339 with offset.
timeMaxstringYesEnd of the interval, RFC3339 with offset.
timeZonestringNoIANA time zone of the response, such as America/Sao_Paulo. The default is UTC.
itemsarrayYesCalendars to check. Each id is a calendar id from List calendars, primary, or the email of a person who shares their calendar with the user.

Supported connections

Your customer connects their Google Calendar account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/google_calendar, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/google_calendar_get_free_busy. It becomes your agent's tool definition with no conversion.

Other Google Calendar tools

See all 8 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.