Google

Calendar API

Manipulates events and other calendar data.

Productivity & workspace#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Manipulates events and other calendar data.

Endpoints 38

acl

  • GETReturns an access control rule./calendars/:calendarId/acl/:ruleIdReturns an access control rule.
  • PUTUpdates an access control rule./calendars/:calendarId/acl/:ruleId?sendNotifications=trueUpdates an access control rule.
  • DELETEDeletes an access control rule./calendars/:calendarId/acl/:ruleIdDeletes an access control rule.
  • PATCHUpdates an access control rule/calendars/:calendarId/acl/:ruleId?sendNotifications=trueUpdates an access control rule. This method supports patch semantics.
  • GETReturns the rules in the access control list for the calendar./calendars/:calendarId/acl?maxResults=0&pageToken=string&showDeleted=true&syncToken=stringReturns the rules in the access control list for the calendar.
  • POSTCreates an access control rule./calendars/:calendarId/acl?sendNotifications=trueCreates an access control rule.
  • POSTWatch for changes to ACL resources./calendars/:calendarId/acl/watch?maxResults=0&pageToken=string&showDeleted=true&syncToken=stringWatch for changes to ACL resources.

calendarList

  • GETReturns a calendar from the user's calendar list./users/me/calendarList/:calendarIdReturns a calendar from the user's calendar list.
  • PUTUpdates an existing calendar on the user's calendar list./users/me/calendarList/:calendarId?colorRgbFormat=trueUpdates an existing calendar on the user's calendar list.
  • DELETERemoves a calendar from the user's calendar list./users/me/calendarList/:calendarIdRemoves a calendar from the user's calendar list.
  • PATCHUpdates an existing calendar on the user's calendar list/users/me/calendarList/:calendarId?colorRgbFormat=trueUpdates an existing calendar on the user's calendar list. This method supports patch semantics.
  • GETReturns the calendars on the user's calendar list./users/me/calendarList?maxResults=0&minAccessRole=freeBusyReader&pageToken=string&showDeleted=true&showHidden=true&showOwnOrganizationOnly=true&syncToken=stringReturns the calendars on the user's calendar list.
  • POSTInserts an existing calendar into the user's calendar list./users/me/calendarList?colorRgbFormat=trueInserts an existing calendar into the user's calendar list.
  • POSTWatch for changes to CalendarList resources./users/me/calendarList/watch?maxResults=0&minAccessRole=freeBusyReader&pageToken=string&showDeleted=true&showHidden=true&showOwnOrganizationOnly=true&syncToken=stringWatch for changes to CalendarList resources.

calendars

  • POSTClears a primary calendar/calendars/:calendarId/clearClears a primary calendar. This operation deletes all events associated with the primary calendar of an account.
  • GETReturns metadata for a calendar./calendars/:calendarIdReturns metadata for a calendar.
  • PUTUpdates metadata for a calendar./calendars/:calendarIdUpdates metadata for a calendar.
  • DELETEDeletes a secondary calendar/calendars/:calendarIdDeletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.
  • PATCHUpdates metadata for a calendar/calendars/:calendarIdUpdates metadata for a calendar. This method supports patch semantics.
  • POSTCreates a secondary calendar. The authenticated user for the request is made the data owner of the new…/calendarsCreates a secondary calendar. The authenticated user for the request is made the data owner of the new calendar. Note: We recommend to authenticate as the…
  • POSTTransfers a secondary calendar between users within a Google Workspace organization/calendars/:calendarId/transferOwnership?newDataOwner=string&useAdminAccess=trueTransfers a secondary calendar between users within a Google Workspace organization. Requires user authentication with Manage Calendars administrator…

channels

  • POSTStop watching resources through this channel/channels/stopStop watching resources through this channel

colors

  • GETReturns the color definitions for calendars and events./colorsReturns the color definitions for calendars and events.

events

  • GETReturns an event based on its Google Calendar ID/calendars/:calendarId/events/:eventId?alwaysIncludeEmail=true&maxAttendees=0&timeZone=stringReturns an event based on its Google Calendar ID. To retrieve an event using its iCalendar ID, call the events.list method using the iCalUID parameter.
  • PUTUpdates an event./calendars/:calendarId/events/:eventId?alwaysIncludeEmail=true&conferenceDataVersion=0&eventLabelVersion=0&maxAttendees=0&sendNotifications=true&sendUpdates=all&supportsAttachments=trueUpdates an event.
  • DELETEDeletes an event./calendars/:calendarId/events/:eventId?sendNotifications=true&sendUpdates=allDeletes an event.
  • PATCHUpdates an event/calendars/:calendarId/events/:eventId?alwaysIncludeEmail=true&conferenceDataVersion=0&eventLabelVersion=0&maxAttendees=0&sendNotifications=true&sendUpdates=all&supportsAttachments=trueUpdates an event. This method supports patch semantics.
  • POSTImports an event/calendars/:calendarId/events/import?conferenceDataVersion=0&eventLabelVersion=0&supportsAttachments=trueImports an event. This operation is used to add a private copy of an existing event to a calendar. Only events with an eventType of default may be imported.…
  • GETReturns events on the specified calendar./calendars/:calendarId/events?alwaysIncludeEmail=true&eventTypes=birthday&iCalUID=string&maxAttendees=0&maxResults=0&orderBy=startTime&pageToken=string&privateExtendedProperty=string&q=string&sharedExtendedProperty=string&showDeleted=true&showHiddenInvitations=true&singleEvents=true&syncToken=string&timeMax=string&timeMin=string&timeZone=string&updatedMin=stringReturns events on the specified calendar.
  • POSTCreates an event./calendars/:calendarId/events?conferenceDataVersion=0&eventLabelVersion=0&maxAttendees=0&sendNotifications=true&sendUpdates=all&supportsAttachments=trueCreates an event.
  • GETReturns instances of the specified recurring event./calendars/:calendarId/events/:eventId/instances?alwaysIncludeEmail=true&maxAttendees=0&maxResults=0&originalStart=string&pageToken=string&showDeleted=true&timeMax=string&timeMin=string&timeZone=stringReturns instances of the specified recurring event.
  • POSTMoves an event to another calendar, i.e/calendars/:calendarId/events/:eventId/move?destination=string&sendNotifications=true&sendUpdates=allMoves an event to another calendar, i.e. changes an event's organizer. Note that only default events can be moved; birthday, focusTime, fromGmail, outOfOffice…
  • POSTCreates an event based on a simple text string./calendars/:calendarId/events/quickAdd?sendNotifications=true&sendUpdates=all&text=stringCreates an event based on a simple text string.
  • POSTWatch for changes to Events resources./calendars/:calendarId/events/watch?alwaysIncludeEmail=true&eventTypes=birthday&iCalUID=string&maxAttendees=0&maxResults=0&orderBy=startTime&pageToken=string&privateExtendedProperty=string&q=string&sharedExtendedProperty=string&showDeleted=true&showHiddenInvitations=true&singleEvents=true&syncToken=string&timeMax=string&timeMin=string&timeZone=string&updatedMin=stringWatch for changes to Events resources.

freebusy

  • POSTReturns free/busy information for a set of calendars./freeBusyReturns free/busy information for a set of calendars.

settings

  • GETReturns a single user setting./users/me/settings/:settingReturns a single user setting.
  • GETReturns all user settings for the authenticated user./users/me/settings?maxResults=0&pageToken=string&syncToken=stringReturns all user settings for the authenticated user.
  • POSTWatch for changes to Settings resources./users/me/settings/watch?maxResults=0&pageToken=string&syncToken=stringWatch for changes to Settings resources.

API details

Base URL
https://www.googleapis.com/calendar/v3
Authentication
OAuth 2.0 (authorization code flow) with 18 scopes
An API key in the key query parameter
Operations
38 operations on 23 pathsPOST 15GET 11PUT 4PATCH 4DELETE 4
Main resources
events 11acl 7calendarList 7calendars 7settings 3channels 1colors 1freebusy 1
Response formats
application/json
Description format
Google API Discovery, API version v3

How to test the Calendar API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Calendar API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 18 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Returns an access control rule.” (GET /calendars/:calendarId/acl/:ruleId), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Calendar API?

Manipulates events and other calendar data. It is listed under Productivity & workspace and has 38 endpoints.

Who publishes the Calendar API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Calendar API?

Requests go to https://www.googleapis.com/calendar/v3. Endpoint paths are added to this base URL.

How do I authenticate with the Calendar API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 18 scopes; an API key in the key query parameter.

How many endpoints does the Calendar API have?

38 operations on 23 paths (15 POST, 11 GET, 4 PUT, 4 PATCH, 4 DELETE). The largest groups are events, acl, calendarList, calendars.

Is forking the Calendar API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.