APIHub
Back to Explore

The Calendar

The Calendar provides a free, public API that returns static JSON files containing public holiday calendars (US federal holidays, every US state, and 30 countries), finance calendars (FOMC meetings, US tax deadlines, stock‑market holidays), and key dates for major sports leagues, all accessible via simple HTTPS endpoints without authentication.

Calendar
OAuth
HTTPS
CORS: Yes
Description enriched
Visit official documentation

Latency

345ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
POST

/calendars

Creates a secondary calendar.

DELETE

/calendars/{calendarId}

Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.

  • calendarId (path, required) — Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
GET

/calendars/{calendarId}

Returns metadata for a calendar.

  • calendarId (path, required) — Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
PATCH

/calendars/{calendarId}

Updates metadata for a calendar. This method supports patch semantics.

  • calendarId (path, required) — Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
PUT

/calendars/{calendarId}

Updates metadata for a calendar.

  • calendarId (path, required) — Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
GET

/calendars/{calendarId}/acl

Returns the rules in the access control list for the calendar.

  • calendarId (path, required) — Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
  • maxResults (query, limit) — Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
  • pageToken (query) — Token specifying which result page to return. Optional.
  • showDeleted (query) — Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.
  • syncToken (query) — 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 entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
POST

/calendars/{calendarId}/acl

Creates an access control rule.

  • calendarId (path, required) — Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
  • sendNotifications (query) — Whether to send notifications about the calendar sharing change. Optional. The default is True.
POST

/calendars/{calendarId}/acl/watch

Watch for changes to ACL resources.

  • calendarId (path, required) — Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
  • maxResults (query, limit) — Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
  • pageToken (query) — Token specifying which result page to return. Optional.
  • showDeleted (query) — Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.
  • syncToken (query) — 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 entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
DELETE

/calendars/{calendarId}/acl/{ruleId}

Deletes an access control rule.

  • calendarId (path, required) — Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
  • ruleId (path, required) — ACL rule identifier.
GET

/calendars/{calendarId}/acl/{ruleId}

Returns an access control rule.

  • calendarId (path, required) — Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
  • ruleId (path, required) — ACL rule identifier.
PATCH

/calendars/{calendarId}/acl/{ruleId}

Updates an access control rule. This method supports patch semantics.

  • calendarId (path, required) — Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
  • ruleId (path, required) — ACL rule identifier.
  • sendNotifications (query) — Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.
PUT

/calendars/{calendarId}/acl/{ruleId}

Updates an access control rule.

  • calendarId (path, required) — Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
  • ruleId (path, required) — ACL rule identifier.
  • sendNotifications (query) — Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.
POST

/calendars/{calendarId}/clear

Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.

  • calendarId (path, required) — Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
GET

/calendars/{calendarId}/events

Returns events on the specified calendar.

  • calendarId (path, required) — Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
  • alwaysIncludeEmail (query) — Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).
  • eventTypes (query) — Event types to return. Optional. Possible values are: - "default" - "focusTime" - "outOfOffice"This parameter can be repeated multiple times to return events of different types. Currently, this is the only allowed value for this field: - ["default", "focusTime", "outOfOffice"] This value will be the default. If you're enrolled in the Working Location developer preview program, in addition to the default value above you can also set the "workingLocation" event type: - ["default", "focusTime", "outOfOffice", "workingLocation"] - ["workingLocation"] Additional combinations of these 4 event types will be made available in later releases. Developer Preview.
  • iCalUID (query) — Specifies an event ID in the iCalendar format to be provided in the response. Optional. Use this if you want to search for an event by its iCalendar ID.
  • maxAttendees (query) — 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.
  • maxResults (query, limit) — 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.
  • orderBy (query) — The order of the events returned in the result. Optional. The default is an unspecified, stable order.
  • pageToken (query) — Token specifying which result page to return. Optional.
  • privateExtendedProperty (query) — 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.
  • q (query) — Free text search terms to find events that match these terms in the following fields: summary, description, location, attendee's displayName, attendee's email. Optional.
  • sharedExtendedProperty (query) — 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.
  • showDeleted (query) — 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.
  • showHiddenInvitations (query) — Whether to include hidden invitations in the result. Optional. The default is False.
  • singleEvents (query) — 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.
  • syncToken (query) — 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. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. These are: - iCalUID - orderBy - privateExtendedProperty - q - sharedExtendedProperty - timeMin - timeMax - updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
  • timeMax (query) — 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.
  • timeMin (query) — 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.
  • timeZone (query) — Time zone used in the response. Optional. The default is the time zone of the calendar.
  • updatedMin (query) — 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.
POST

/calendars/{calendarId}/events

Creates an event.

  • calendarId (path, required) — Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
  • conferenceDataVersion (query) — Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.
  • maxAttendees (query) — 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.
  • sendNotifications (query) — Deprecated. Please use sendUpdates instead. Whether to send notifications about the creation of the new event. Note that some emails might still be sent even if you set the value to false. The default is false.
  • sendUpdates (query) — Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false.
  • supportsAttachments (query) — Whether API client performing operation supports event attachments. Optional. The default is False.
DELETE

/users/me/calendarList/{calendarId}

Removes a calendar from the user's calendar list.

  • calendarId (path, required) — Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
POST

/calendars/{calendarId}/events/import

Imports an event. This operation is used to add a private copy of an existing event to a calendar.

  • calendarId (path, required) — Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
  • conferenceDataVersion (query) — Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.
  • supportsAttachments (query) — Whether API client performing operation supports event attachments. Optional. The default is False.
POST

/calendars/{calendarId}/events/quickAdd

Creates an event based on a simple text string.

  • calendarId (path, required) — Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
  • text (query, required) — The text describing the event to be created.
  • sendNotifications (query) — Deprecated. Please use sendUpdates instead. Whether to send notifications about the creation of the event. Note that some emails might still be sent even if you set the value to false. The default is false.
  • sendUpdates (query) — Guests who should receive notifications about the creation of the new event.
POST

/calendars/{calendarId}/events/watch

Watch for changes to Events resources.

  • calendarId (path, required) — Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
  • alwaysIncludeEmail (query) — Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).
  • eventTypes (query) — Event types to return. Optional. Possible values are: - "default" - "focusTime" - "outOfOffice"This parameter can be repeated multiple times to return events of different types. Currently, this is the only allowed value for this field: - ["default", "focusTime", "outOfOffice"] This value will be the default. If you're enrolled in the Working Location developer preview program, in addition to the default value above you can also set the "workingLocation" event type: - ["default", "focusTime", "outOfOffice", "workingLocation"] - ["workingLocation"] Additional combinations of these 4 event types will be made available in later releases. Developer Preview.
  • iCalUID (query) — Specifies an event ID in the iCalendar format to be provided in the response. Optional. Use this if you want to search for an event by its iCalendar ID.
  • maxAttendees (query) — 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.
  • maxResults (query, limit) — 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.
  • orderBy (query) — The order of the events returned in the result. Optional. The default is an unspecified, stable order.
  • pageToken (query) — Token specifying which result page to return. Optional.
  • privateExtendedProperty (query) — 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.
  • q (query) — Free text search terms to find events that match these terms in the following fields: summary, description, location, attendee's displayName, attendee's email. Optional.
  • sharedExtendedProperty (query) — 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.
  • showDeleted (query) — 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.
  • showHiddenInvitations (query) — Whether to include hidden invitations in the result. Optional. The default is False.
  • singleEvents (query) — 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.
  • syncToken (query) — 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. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. These are: - iCalUID - orderBy - privateExtendedProperty - q - sharedExtendedProperty - timeMin - timeMax - updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
  • timeMax (query) — 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.
  • timeMin (query) — 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.
  • timeZone (query) — Time zone used in the response. Optional. The default is the time zone of the calendar.
  • updatedMin (query) — 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.
DELETE

/calendars/{calendarId}/events/{eventId}

Deletes an event.

  • calendarId (path, required) — Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
  • eventId (path, required) — Event identifier.
  • sendNotifications (query) — Deprecated. Please use sendUpdates instead. Whether to send notifications about the deletion of the event. Note that some emails might still be sent even if you set the value to false. The default is false.
  • sendUpdates (query) — Guests who should receive notifications about the deletion of the event.
GET

/calendars/{calendarId}/events/{eventId}

Returns 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.

  • calendarId (path, required) — Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
  • eventId (path, required) — Event identifier.
  • alwaysIncludeEmail (query) — Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).
  • maxAttendees (query) — 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.
  • timeZone (query) — Time zone used in the response. Optional. The default is the time zone of the calendar.
PATCH

/calendars/{calendarId}/events/{eventId}

Updates an event. This method supports patch semantics.

  • calendarId (path, required) — Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
  • eventId (path, required) — Event identifier.
  • alwaysIncludeEmail (query) — Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).
  • conferenceDataVersion (query) — Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.
  • maxAttendees (query) — 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.
  • sendNotifications (query) — Deprecated. Please use sendUpdates instead. Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.
  • sendUpdates (query) — Guests who should receive notifications about the event update (for example, title changes, etc.).
  • supportsAttachments (query) — Whether API client performing operation supports event attachments. Optional. The default is False.
PUT

/calendars/{calendarId}/events/{eventId}

Updates an event.

  • calendarId (path, required) — Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
  • eventId (path, required) — Event identifier.
  • alwaysIncludeEmail (query) — Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).
  • conferenceDataVersion (query) — Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.
  • maxAttendees (query) — 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.
  • sendNotifications (query) — Deprecated. Please use sendUpdates instead. Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.
  • sendUpdates (query) — Guests who should receive notifications about the event update (for example, title changes, etc.).
  • supportsAttachments (query) — Whether API client performing operation supports event attachments. Optional. The default is False.
GET

/users/me/calendarList/{calendarId}

Returns a calendar from the user's calendar list.

  • calendarId (path, required) — Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
GET

/calendars/{calendarId}/events/{eventId}/instances

Returns instances of the specified recurring event.

  • calendarId (path, required) — Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
  • eventId (path, required) — Recurring event identifier.
  • alwaysIncludeEmail (query) — Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).
  • maxAttendees (query) — 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.
  • maxResults (query, limit) — Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.
  • originalStart (query) — The original start time of the instance in the result. Optional.
  • pageToken (query) — Token specifying which result page to return. Optional.
  • showDeleted (query) — Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events will still be included if singleEvents is False. Optional. The default is False.
  • timeMax (query) — 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.
  • timeMin (query) — Lower bound (inclusive) 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.
  • timeZone (query) — Time zone used in the response. Optional. The default is the time zone of the calendar.
POST

/calendars/{calendarId}/events/{eventId}/move

Moves an event to another calendar, i.e. changes an event's organizer.

  • calendarId (path, required) — Calendar identifier of the source calendar where the event currently is on.
  • eventId (path, required) — Event identifier.
  • destination (query, required) — Calendar identifier of the target calendar where the event is to be moved to.
  • sendNotifications (query) — Deprecated. Please use sendUpdates instead. Whether to send notifications about the change of the event's organizer. Note that some emails might still be sent even if you set the value to false. The default is false.
  • sendUpdates (query) — Guests who should receive notifications about the change of the event's organizer.
POST

/channels/stop

Stop watching resources through this channel

GET

/colors

Returns the color definitions for calendars and events.

POST

/freeBusy

Returns free/busy information for a set of calendars.

GET

/users/me/calendarList

Returns the calendars on the user's calendar list.

  • maxResults (query, limit) — Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
  • minAccessRole (query) — The minimum access role for the user in the returned entries. Optional. The default is no restriction.
  • pageToken (query) — Token specifying which result page to return. Optional.
  • showDeleted (query) — Whether to include deleted calendar list entries in the result. Optional. The default is False.
  • showHidden (query) — Whether to show hidden entries. Optional. The default is False.
  • syncToken (query) — 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. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
POST

/users/me/calendarList

Inserts an existing calendar into the user's calendar list.

  • colorRgbFormat (query) — Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.
POST

/users/me/calendarList/watch

Watch for changes to CalendarList resources.

  • maxResults (query, limit) — Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
  • minAccessRole (query) — The minimum access role for the user in the returned entries. Optional. The default is no restriction.
  • pageToken (query) — Token specifying which result page to return. Optional.
  • showDeleted (query) — Whether to include deleted calendar list entries in the result. Optional. The default is False.
  • showHidden (query) — Whether to show hidden entries. Optional. The default is False.
  • syncToken (query) — 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. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
PATCH

/users/me/calendarList/{calendarId}

Updates an existing calendar on the user's calendar list. This method supports patch semantics.

  • calendarId (path, required) — Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
  • colorRgbFormat (query) — Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.
PUT

/users/me/calendarList/{calendarId}

Updates an existing calendar on the user's calendar list.

  • calendarId (path, required) — Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
  • colorRgbFormat (query) — Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.
GET

/users/me/settings

Returns all user settings for the authenticated user.

  • maxResults (query, limit) — Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
  • pageToken (query) — Token specifying which result page to return. Optional.
  • syncToken (query) — 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. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
POST

/users/me/settings/watch

Watch for changes to Settings resources.

  • maxResults (query, limit) — Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
  • pageToken (query) — Token specifying which result page to return. Optional.
  • syncToken (query) — 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. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
GET

/users/me/settings/{setting}

Returns a single user setting.

  • setting (path, required) — The id of the user setting.

37 endpoints auto-detected

Authentication

This API requires authentication: OAuth.

curl -X POST \
  "https://the-calendar.net/api//calendars"

the-calendar.net · HTTPS only