Calendar API

Content-Type: application/json

Example:

{
  "kind": "calendar#acl",
  "etag": "\"00000000000000000000\"",
  "nextPageToken": "user:abc@example.com!",
  "items": [
    {
      "kind": "calendar#aclRule",
      "etag": "\"00000000000000000000\"",
      "id": "user:cba.fed@zoom.com",
      "scope": {
        "type": "default"
      },
      "role": "reader"
    }
  ]
}

• role (required)

  string, possible values: "none", "freeBusyReader", "reader", "writer", "owner" — The role assigned to the scope.

• scope (required)

  object — The extent to which calendar access is granted by this ACL rule.

Content-Type: application/json

Example:

{
  "kind": "calendar#aclRule",
  "etag": "\"00000000000000000000\"",
  "id": "user:cba.fed@zoom.com",
  "scope": {
    "type": "default"
  },
  "role": "reader"
}

Content-Type: application/json

Example:

{
  "kind": "calendar#aclRule",
  "etag": "\"00000000000000000000\"",
  "id": "user:cba.fed@zoom.com",
  "scope": {
    "type": "default"
  },
  "role": "reader"
}

• role (required)

  string, possible values: "none", "freeBusyReader", "reader", "writer", "owner" — The role assigned to the scope.

• scope (required)

  object — The extent to which calendar access is granted by this ACL rule.

  One of:

  • type (required)

    string, possible values: "default" — The type of the scope.

  • type (required)

    string, possible values: "domain" — The type of scope.

  • value

    string, format: hostname — The name of a domain.

  • type (required)

    string, possible values: "group", "user" — The type of scope.

  • value

    string, format: email — The email address of a user or group.

Content-Type: application/json

Example:

{
  "kind": "calendar#aclRule",
  "etag": "\"00000000000000000000\"",
  "id": "user:cba.fed@zoom.com",
  "scope": {
    "type": "default"
  },
  "role": "reader"
}

Content-Type: application/json

Example:

{
  "kind": "calendar#calendarList",
  "etag": "\"00000000000000000000\"",
  "nextPageToken": "c_fn3h8xf6ce6ehefnclpp869700@group.calendar.zoom.us!",
  "items": [
    {
      "kind": "calendar#calendarListEntry",
      "etag": "\"00000000000000000000\"",
      "id": "abc.def@zoom.com",
      "summary": "My calendar",
      "description": "Calendar description",
      "location": "San Jose",
      "timeZone": "America/Los_Angeles",
      "colorId": "6",
      "backgroundColor": "#0088aa",
      "foregroundColor": "#ffffff",
      "hidden": false,
      "selected": false,
      "accessRole": "freeBusyReader",
      "defaultReminders": [
        {
          "method": "email",
          "minutes": 5
        }
      ],
      "defaultAllDayReminders": [
        {
          "method": "email",
          "minutes": 5
        }
      ],
      "notificationSettings": {
        "notifications": [
          {
            "type": "eventCreation",
            "method": "email"
          }
        ]
      },
      "primary": false,
      "deleted": false,
      "summaryOverride": "new summary"
    }
  ]
}

• id (required)

  string, format: email — The identifier of the calendar.

• accessRole

  string, possible values: "freeBusyReader", "reader", "writer", "owner" — The effective access role that the authenticated user has on the calendar.

• backgroundColor

  string — The main color of the calendar in the hexadecimal format.

• colorId

  string — The color of the calendar.

• defaultAllDayReminders

  array — The default reminders for all day events that the authenticated user has for this calendar.

  Items:

  • method

    string, possible values: "email", "popup" — The method this reminder uses.

  • minutes

    integer — The number of minutes before the start of the event when the reminder should trigger.

• defaultReminders

  array — The default reminders for non-all day events that the authenticated user has for this calendar.

  Items:

  • method

    string, possible values: "email", "popup" — The method this reminder uses.

  • minutes

    integer — The number of minutes before the start of the event when the reminder should trigger.

• deleted

  boolean — Whether this calendar list entry has been deleted from the calendar list.

• description

  string — The description of the calendar.

• foregroundColor

  string — The foreground color of the calendar in the hexadecimal format.

• hidden

  boolean — Whether the calendar has been hidden from the list.

• location

  string — The geographic location of the calendar as free-form text.

• notificationSettings

  object — The notifications that the authenticated user is receiving for this calendar.

  • notifications

    array — The list of notifications set for this calendar.

    Items:

    • method

      string, possible values: "email" — The method that delivers the notification.

    • type

      string, possible values: "eventCreation", "eventChange", "eventCancellation", "eventResponse", "agenda" — The type of notification.

• primary

  boolean — Whether the calendar is the primary calendar of the authenticated user.

• selected

  boolean — Whether the calendar content shows up in the calendar UI.

• summary

  string — The title of the calendar.

• summaryOverride

  string — The summary that the authenticated user has set for this calendar.

• timeZone

  string — The time zone of the calendar.

Content-Type: application/json

Example:

{
  "kind": "calendar#calendarListEntry",
  "etag": "\"00000000000000000000\"",
  "id": "abc.def@zoom.com",
  "summary": "My calendar",
  "description": "Calendar description",
  "location": "San Jose",
  "timeZone": "America/Los_Angeles",
  "colorId": "6",
  "backgroundColor": "#0088aa",
  "foregroundColor": "#ffffff",
  "hidden": false,
  "selected": false,
  "accessRole": "freeBusyReader",
  "defaultReminders": [
    {
      "method": "email",
      "minutes": 5
    }
  ],
  "defaultAllDayReminders": [
    {
      "method": "email",
      "minutes": 5
    }
  ],
  "notificationSettings": {
    "notifications": [
      {
        "type": "eventCreation",
        "method": "email"
      }
    ]
  },
  "primary": false,
  "deleted": false,
  "summaryOverride": "new summary"
}

Content-Type: application/json

Example:

{
  "kind": "calendar#calendarListEntry",
  "etag": "\"00000000000000000000\"",
  "id": "abc.def@zoom.com",
  "summary": "My calendar",
  "description": "Calendar description",
  "location": "San Jose",
  "timeZone": "America/Los_Angeles",
  "colorId": "6",
  "backgroundColor": "#0088aa",
  "foregroundColor": "#ffffff",
  "hidden": false,
  "selected": false,
  "accessRole": "freeBusyReader",
  "defaultReminders": [
    {
      "method": "email",
      "minutes": 5
    }
  ],
  "defaultAllDayReminders": [
    {
      "method": "email",
      "minutes": 5
    }
  ],
  "notificationSettings": {
    "notifications": [
      {
        "type": "eventCreation",
        "method": "email"
      }
    ]
  },
  "primary": false,
  "deleted": false,
  "summaryOverride": "new summary"
}

• id (required)

  string, format: email — The identifier of the calendar.

• accessRole

  string, possible values: "freeBusyReader", "reader", "writer", "owner" — The effective access role that the authenticated user has on the calendar.

• backgroundColor

  string — The main color of the calendar in the hexadecimal format.

• colorId

  string — The color of the calendar.

• defaultAllDayReminders

  array — The default reminders for all day events that the authenticated user has for this calendar.

  Items:

  • method

    string, possible values: "email", "popup" — The method this reminder uses.

  • minutes

    integer — The number of minutes before the start of the event when the reminder should trigger.

• defaultReminders

  array — The default reminders for non-all day events that the authenticated user has for this calendar.

  Items:

  • method

    string, possible values: "email", "popup" — The method that this reminder uses.

  • minutes

    integer — The number of minutes before the start of the event when the reminder should trigger.

• deleted

  boolean — Whether this calendar list entry has been deleted from the calendar list.

• description

  string — The description of the calendar.

• foregroundColor

  string — The foreground color of the calendar in the hexadecimal format.

• hidden

  boolean — Whether the calendar has been hidden from the list.

• location

  string — The geographic location of the calendar as free-form text.

• notificationSettings

  object — The notifications that the authenticated user is receiving for this calendar.

  • notifications

    array — The list of notifications set for this calendar.

    Items:

    • method

      string, possible values: "email" — The method to deliver the notification.

    • type

      string, possible values: "eventCreation", "eventChange", "eventCancellation", "eventResponse", "agenda" — The type of notification.

• primary

  boolean — Whether the calendar is the primary calendar of the authenticated user.

• selected

  boolean — Whether the calendar content shows up in the calendar UI.

• summary

  string — The title of the calendar.

• summaryOverride

  string — The summary that the authenticated user has set for this calendar.

• timeZone

  string — The time zone of the calendar.

Content-Type: application/json

Example:

{
  "kind": "calendar#calendarListEntry",
  "etag": "\"00000000000000000000\"",
  "id": "abc.def@zoom.com",
  "summary": "My calendar",
  "description": "Calendar description",
  "location": "San Jose",
  "timeZone": "America/Los_Angeles",
  "colorId": "6",
  "backgroundColor": "#0088aa",
  "foregroundColor": "#ffffff",
  "hidden": false,
  "selected": false,
  "accessRole": "freeBusyReader",
  "defaultReminders": [
    {
      "method": "email",
      "minutes": 5
    }
  ],
  "defaultAllDayReminders": [
    {
      "method": "email",
      "minutes": 5
    }
  ],
  "notificationSettings": {
    "notifications": [
      {
        "type": "eventCreation",
        "method": "email"
      }
    ]
  },
  "primary": false,
  "deleted": false,
  "summaryOverride": "new summary"
}

• summary (required)

  string — The title of the calendar.

Content-Type: application/json

Example:

{
  "kind": "calendar#calendar",
  "etag": "\"00000000000000000000\"",
  "id": "abc.def@zoom.com",
  "summary": "My calendar",
  "timeZone": "America/Los_Angeles",
  "description": "calendar description",
  "location": "San Jose"
}

Content-Type: application/json

Example:

{
  "kind": "calendar#calendar",
  "etag": "\"00000000000000000000\"",
  "id": "abc.def@zoom.com",
  "summary": "My calendar",
  "timeZone": "America/Los_Angeles",
  "description": "calendar description",
  "location": "San Jose"
}

• description

  string — The description of the calendar.

• location

  string — The geographic location of the calendar as free-form text.

• summary

  string — The title of the calendar.

• timeZone

  string — The time zone of the calendar.

Content-Type: application/json

Example:

{
  "kind": "calendar#calendar",
  "etag": "\"00000000000000000000\"",
  "id": "abc.def@zoom.com",
  "summary": "My calendar",
  "timeZone": "America/Los_Angeles",
  "description": "calendar description",
  "location": "San Jose"
}

Content-Type: application/json

Example:

{
  "kind": "\"calendar#colors\"",
  "updated": "2012-02-14T00:00:00Z",
  "calendar": [
    {
      "color_id": "\"1\"",
      "value": {
        "foreground": "\"#FD3D4A\"",
        "background": "\"#F7F9FA\""
      }
    }
  ],
  "event": [
    {
      "color_id": "\"1\"",
      "value": {
        "foreground": "\"#FD3D4A\"",
        "background": "\"#F7F9FA\""
      }
    }
  ]
}

Content-Type: application/json

Example:

{
  "kind": "calendar#events",
  "etag": "\"00000000000000000000\"",
  "summary": "calendar summary",
  "description": "calendar description",
  "updated": "2020-01-01T00:00:00Z",
  "timeZone": "America/Los_Angeles",
  "accessRole": "owner",
  "defaultReminders": [
    {
      "method": "email",
      "minutes": 5
    }
  ],
  "nextPageToken": "ffffffffa8b32bff_te7ldipj31fqfo3mw3jjzgz6c0!",
  "items": [
    {
      "start": {
        "date": "2020-01-01",
        "dateTime": "2020-01-01T00:00:00Z",
        "timeZone": "America/Los_Angeles"
      },
      "end": {
        "date": "2020-01-01",
        "dateTime": "2020-01-01T00:00:00Z",
        "timeZone": "America/Los_Angeles"
      },
      "attendees": [
        {
          "additionalGuests": 1,
          "displayName": "Mark Joe",
          "email": "mark.joe@zoom.com",
          "optional": false,
          "resource": false,
          "responseStatus": "needsAction"
        }
      ],
      "colorId": "5",
      "description": "event description",
      "guestsCanInviteOthers": true,
      "guestsCanModify": false,
      "guestsCanSeeOtherGuests": true,
      "location": "San Jose",
      "recurrence": [
        "RRULE:FREQ=DAILY;COUNT=2;INTERVAL=3"
      ],
      "reminders": {
        "useDefault": false,
        "overrides": [
          {
            "method": "email",
            "minutes": 5
          }
        ]
      },
      "status": "confirmed",
      "summary": "event title",
      "transparency": "transparent",
      "visibility": "default",
      "id": "0lyk1qjjd8t8thnf5y1f02a6c0",
      "created": "2020-01-01T00:00:00Z",
      "creator": {
        "email": "mark.joe@zoom.com"
      },
      "organizer": {
        "email": "mark.joe@zoom.com"
      },
      "kind": "calendar#event",
      "updated": "2020-01-01T00:00:00Z"
    }
  ],
  "nextSyncToken": "The next page token retrieves events changed after returning this result. This system omits it when you add the `nextPageToken`. Users need to retrieve all pages of result before getting the `nextSyncToken`."
}

• end (required)

  object — The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

  • date

    string, format: date — The date, in the format "yyyy-mm-dd", if this is an all-day event.

  • dateTime

    string, format: date-time — The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in `timeZone`.

  • timeZone

    string — The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event's start or end.

• start (required)

  object — The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

  • date

    string, format: date — The date, in the format "yyyy-mm-dd", if this is an all-day event.

  • dateTime

    string, format: date-time — The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in `timeZone`.

  • timeZone

    string — The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event's start or end.

• attendees

  array — The attendees of the event.

  Items:

  • email (required)

    string, format: email — The attendee's email address.

  • additionalGuests

    integer — The number of additional guests. Optional. The default is 0.

  • displayName

    string — The attendee's name, if available.

  • optional

    boolean — Whether this is an optional attendee. Optional. The default is False.

  • resource

    boolean — Whether the attendee is a resource. It can only be set when the attendee is added to the event for the first time.

  • responseStatus

    string, possible values: "needsAction", "declined", "tentative", "accepted" — The attendee's response status.

• colorId

  string — The color of the event. This is an ID referring to an entry in the event section of the colors definition (`use color.get`).

• description

  string — The description of the event.

• guestsCanInviteOthers

  boolean — Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

• guestsCanModify

  boolean — Whether attendees other than the organizer can modify the event. Optional. The default is False.

• guestsCanSeeOtherGuests

  boolean — Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

• location

  string — The geographic location of the event as free-form text.

• recurrence

  array — The list of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event.

  Items:

  string — A recurring rule.

• reminders

  object — The information about the event's reminders for the authenticated user.

  • overrides

    array — If the event doesn't use the default reminders, this field lists the reminders specific to the event. If not, it indicates that no reminders are set for this event.

    Items:

    • method

      string, possible values: "email", "popup" — The method that this reminder uses.

    • minutes

      integer — Number of minutes before the start of the event when the reminder should trigger.

  • useDefault

    boolean — Whether the default reminders of the calendar apply to the event.

• status

  string, possible values: "confirmed", "tentative", "cancelled" — The status of the event.

• summary

  string — The title of the event.

• transparency

  string, possible values: "opaque", "transparent" — Whether the event blocks time on the calendar.

• visibility

  string, possible values: "default", "public", "private" — The visibility of the event.

Content-Type: application/json

Example:

{
  "start": {
    "date": "2020-01-01",
    "dateTime": "2020-01-01T00:00:00Z",
    "timeZone": "America/Los_Angeles"
  },
  "end": {
    "date": "2020-01-01",
    "dateTime": "2020-01-01T00:00:00Z",
    "timeZone": "America/Los_Angeles"
  },
  "attendees": [
    {
      "additionalGuests": 1,
      "displayName": "Mark Joe",
      "organizer": false,
      "email": "mark.joe@zoom.com",
      "optional": false,
      "self": false,
      "resource": false,
      "responseStatus": "needsAction"
    }
  ],
  "colorId": "5",
  "description": "event description",
  "guestsCanInviteOthers": true,
  "guestsCanModify": false,
  "guestsCanSeeOtherGuests": true,
  "location": "San Jose",
  "recurrence": [
    "RRULE:FREQ=DAILY;COUNT=2;INTERVAL=3"
  ],
  "reminders": {
    "useDefault": false,
    "overrides": [
      {
        "method": "email",
        "minutes": 5
      }
    ]
  },
  "status": "confirmed",
  "summary": "event title",
  "transparency": "transparent",
  "visibility": "default",
  "id": "0lyk1qjjd8t8thnf5y1f02a6c0",
  "created": "2020-01-01T00:00:00Z",
  "creator": {
    "email": "mark.joe@zoom.com"
  },
  "organizer": {
    "email": "mark.joe@zoom.com"
  },
  "kind": "calendar#event",
  "updated": "2020-01-01T00:00:00Z"
}

• end (required)

  object — The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

  • date

    string, format: date — The date, in the format "yyyy-mm-dd", if this is an all-day event.

  • dateTime

    string, format: date-time — The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in `timeZone`.

  • timeZone

    string — The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event's start or end.

• start (required)

  object — The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

  • date

    string, format: date — The date, in the format "yyyy-mm-dd", if this is an all-day event.

  • dateTime

    string, format: date-time — The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in `timeZone`.

  • timeZone

    string — The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event's start or end.

• attendees

  array — The attendees of the event.

  Items:

  • email (required)

    string, format: email — The attendee's email address.

  • additionalGuests

    integer — The number of additional guests. Optional. The default is 0.

  • displayName

    string — The attendee's name, if available.

  • optional

    boolean — Whether this is an optional attendee. Optional. The default is false.

  • resource

    boolean — Whether the attendee is a resource. It can only be set when the attendee is added to the event for the first time.

  • responseStatus

    string, possible values: "needsAction", "declined", "tentative", "accepted" — The attendee's response status.

• colorId

  string — The color of the event. This is an ID referring to an entry in the event section of the colors definition (use `color.get`).

• description

  string — Description of the event.

• guestsCanInviteOthers

  boolean — Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

• guestsCanModify

  boolean — Whether attendees other than the organizer can modify the event. Optional. The default is False.

• guestsCanSeeOtherGuests

  boolean — Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

• location

  string — The geographic location of the event as free-form text.

• recurrence

  array — The list of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event.

  Items:

  string — A recurring rule.

• reminders

  object — The information about the event's reminders for the authenticated user.

  • overrides

    array — If the event doesn't use the default reminders, this field lists the reminders specific to the event. If not set, it indicates that no reminders are set for this event.

    Items:

    • method

      string, possible values: "email", "popup" — The method that this reminder uses.

    • minutes

      integer — The number of minutes before the start of the event when the reminder should trigger.

  • useDefault

    boolean — Whether the default reminders of the calendar apply to the event.

• status

  string, possible values: "confirmed", "tentative", "cancelled" — The status of the event.

• summary

  string — The title of the event.

• transparency

  string, possible values: "opaque", "transparent" — Whether the event blocks time on the calendar.

• visibility

  string, possible values: "default", "public", "private" — The visibility of the event.

Content-Type: application/json

Example:

{
  "start": {
    "date": "2020-01-01",
    "dateTime": "2020-01-01T00:00:00Z",
    "timeZone": "America/Los_Angeles"
  },
  "end": {
    "date": "2020-01-01",
    "dateTime": "2020-01-01T00:00:00Z",
    "timeZone": "America/Los_Angeles"
  },
  "attendees": [
    {
      "additionalGuests": 1,
      "displayName": "Mark Joe",
      "email": "mark.joe@zoom.com",
      "optional": false,
      "resource": false,
      "responseStatus": "needsAction"
    }
  ],
  "colorId": "5",
  "description": "event description",
  "guestsCanInviteOthers": true,
  "guestsCanModify": false,
  "guestsCanSeeOtherGuests": true,
  "location": "San Jose",
  "recurrence": [
    "RRULE:FREQ=DAILY;COUNT=2;INTERVAL=3"
  ],
  "reminders": {
    "useDefault": false,
    "overrides": [
      {
        "method": "email",
        "minutes": 5
      }
    ]
  },
  "status": "confirmed",
  "summary": "event title",
  "transparency": "transparent",
  "visibility": "default",
  "id": "0lyk1qjjd8t8thnf5y1f02a6c0",
  "created": "2020-01-01T00:00:00Z",
  "creator": {
    "email": "mark.joe@zoom.com"
  },
  "organizer": {
    "email": "mark.joe@zoom.com"
  },
  "kind": "calendar#event",
  "updated": "2020-01-01T00:00:00Z"
}

Content-Type: application/json

Example:

{
  "start": {
    "date": "2020-01-01",
    "dateTime": "2020-01-01T00:00:00Z",
    "timeZone": "America/Los_Angeles"
  },
  "end": {
    "date": "2020-01-01",
    "dateTime": "2020-01-01T00:00:00Z",
    "timeZone": "America/Los_Angeles"
  },
  "attendees": [
    {
      "additionalGuests": 1,
      "displayName": "Mark Joe",
      "email": "mark.joe@zoom.com",
      "optional": false,
      "resource": false,
      "responseStatus": "needsAction"
    }
  ],
  "colorId": "5",
  "description": "event description",
  "guestsCanInviteOthers": true,
  "guestsCanModify": false,
  "guestsCanSeeOtherGuests": true,
  "location": "San Jose",
  "recurrence": [
    "RRULE:FREQ=DAILY;COUNT=2;INTERVAL=3"
  ],
  "reminders": {
    "useDefault": false,
    "overrides": [
      {
        "method": "email",
        "minutes": 5
      }
    ]
  },
  "status": "confirmed",
  "summary": "event title",
  "transparency": "transparent",
  "visibility": "default",
  "id": "0lyk1qjjd8t8thnf5y1f02a6c0",
  "created": "2020-01-01T00:00:00Z",
  "creator": {
    "email": "mark.joe@zoom.com"
  },
  "organizer": {
    "email": "mark.joe@zoom.com"
  },
  "kind": "calendar#event",
  "updated": "2020-01-01T00:00:00Z"
}

Content-Type: application/json

Example:

{
  "attendees": [
    {
      "additionalGuests": 1,
      "displayName": "Mark Joe",
      "email": "mark.joe@zoom.com",
      "optional": false,
      "resource": false,
      "responseStatus": "needsAction"
    }
  ],
  "colorId": "5",
  "created": "2020-01-01T00:00:00Z",
  "creator": {
    "email": "mark.joe@zoom.com"
  },
  "description": "event description",
  "end": {
    "date": "2020-01-01",
    "dateTime": "2020-01-01T00:00:00Z",
    "timeZone": "America/Los_Angeles"
  },
  "etag": "\"123456789\"",
  "eventType": "default",
  "guestsCanInviteOthers": true,
  "guestsCanModify": false,
  "guestsCanSeeOtherGuests": true,
  "iCalUID": "abc@zoom.us",
  "id": "0lyk1qjjd8t8thnf5y1f02a6c0",
  "kind": "calendar#event",
  "location": "San Jose",
  "organizer": {
    "email": "mark.joe@zoom.com"
  },
  "recurrence": [
    "RRULE:FREQ=DAILY;COUNT=2;INTERVAL=3"
  ],
  "reminders": {
    "useDefault": false,
    "overrides": [
      {
        "method": "email",
        "minutes": 5
      }
    ]
  },
  "sequence": 1,
  "start": {
    "timeZone": "America/Los_Angeles",
    "date": "2020-01-01",
    "dateTime": "2020-01-01T00:00:00Z"
  },
  "status": "confirmed",
  "summary": "event title",
  "transparency": "transparent",
  "visibility": "default",
  "updated": "2020-01-01T00:00:00Z"
}

• end (required)

  object — The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

• start (required)

  object — The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

• attendees

  array — The attendees of the event.

  Items:

  • email (required)

    string, format: email — The attendee's email address.

  • additionalGuests

    integer — The number of additional guests. The default is 0. Optional.

  • displayName

    string — The attendee's name, if available.

  • optional

    boolean — Whether this is an optional attendee. The default is False. Optional.

  • resource

    boolean — Whether the attendee is a resource. It can only be set when the attendee is added to the event for the first time.

  • responseStatus

    string, possible values: "needsAction", "declined", "tentative", "accepted" — The attendee's response status.

• colorId

  string — The color of the event. This is an ID referring to an entry in the event section of the colors definition (use `color.get`).

• description

  string — The description of the event.

• guestsCanInviteOthers

  boolean — Whether attendees other than the organizer can invite others to the event. The default is True. Optional.

• guestsCanModify

  boolean — Whether attendees other than the organizer can modify the event. The default is False. Optional.

• guestsCanSeeOtherGuests

  boolean — Whether attendees other than the organizer can see who the event's attendees are. The default is True. Optional.

• location

  string — The geographic location of the event as free-form text.

• recurrence

  array — The list of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event.

  Items:

  string — A recurring rule.

• reminders

  object — The information about the event's reminders for the authenticated user.

  • overrides

    array — If the event doesn't use the default reminders, this field lists the reminders specific to the event. If not, it indicates that no reminders are set for this event.

    Items:

    • method

      string, possible values: "email", "popup" — The method this reminder uses.

    • minutes

      integer — The number of minutes before the start of the event when the reminder should trigger.

  • useDefault

    boolean — Whether the default reminders of the calendar apply to the event.

• status

  string, possible values: "confirmed", "tentative", "cancelled" — The status of the event.

• summary

  string — The title of the event.

• transparency

  string, possible values: "opaque", "transparent" — Whether the event blocks time on the calendar.

• visibility

  string, possible values: "default", "public", "private" — The visibility of the event.

Content-Type: application/json

Example:

{
  "start": {
    "dateTime": "2020-01-01T00:00:00Z",
    "date": "2020-01-01",
    "timeZone": "America/Los_Angeles"
  },
  "end": {
    "dateTime": "2020-01-01T01:00:00Z",
    "date": "2020-01-02",
    "timeZone": "America/Los_Angeles"
  },
  "attendees": [
    {
      "additionalGuests": 1,
      "displayName": "Mark Joe",
      "email": "mark.joe@zoom.com",
      "optional": false,
      "resource": false,
      "responseStatus": "needsAction"
    }
  ],
  "colorId": "5",
  "description": "event description",
  "guestsCanInviteOthers": true,
  "guestsCanModify": false,
  "guestsCanSeeOtherGuests": true,
  "location": "San Jose",
  "recurrence": [
    "RRULE:FREQ=DAILY;COUNT=2;INTERVAL=3"
  ],
  "reminders": {
    "useDefault": false,
    "overrides": [
      {
        "method": "email",
        "minutes": 5
      }
    ]
  },
  "status": "confirmed",
  "summary": "event title",
  "transparency": "transparent",
  "visibility": "default",
  "id": "0lyk1qjjd8t8thnf5y1f02a6c0",
  "created": "2020-01-01T00:00:00Z",
  "creator": {
    "email": "mark.joe@zoom.com"
  },
  "organizer": {
    "email": "mark.joe@zoom.com"
  },
  "kind": "calendar#event",
  "updated": "2020-01-01T00:00:00Z"
}

Content-Type: application/json

Example:

{
  "kind": "calendar#events",
  "etag": "\"00000000000000000000\"",
  "summary": "calendar summary",
  "description": "calendar description",
  "updated": "2020-01-01T00:00:00Z",
  "timeZone": "America/Los_Angeles",
  "accessRole": "owner",
  "defaultReminders": [
    {
      "method": "email",
      "minutes": 5
    }
  ],
  "nextPageToken": "ffffffffa8b32bff_te7ldipj31fqfo3mw3jjzgz6c0!",
  "items": [
    {
      "start": {
        "date": "2020-01-01",
        "dateTime": "2020-01-01T00:00:00Z",
        "timeZone": "America/Los_Angeles"
      },
      "end": {
        "date": "2020-01-01",
        "dateTime": "2020-01-01T00:00:00Z",
        "timeZone": "America/Los_Angeles"
      },
      "attendees": [
        {
          "additionalGuests": 1,
          "displayName": "Mark Joe",
          "email": "mark.joe@zoom.com",
          "optional": false,
          "resource": false,
          "responseStatus": "needsAction"
        }
      ],
      "colorId": "5",
      "description": "event description",
      "guestsCanInviteOthers": true,
      "guestsCanModify": false,
      "guestsCanSeeOtherGuests": true,
      "location": "San Jose",
      "recurrence": [
        "RRULE:FREQ=DAILY;COUNT=2;INTERVAL=3"
      ],
      "reminders": {
        "useDefault": false,
        "overrides": [
          {
            "method": "email",
            "minutes": 5
          }
        ]
      },
      "status": "confirmed",
      "summary": "event title",
      "transparency": "transparent",
      "visibility": "default",
      "id": "0lyk1qjjd8t8thnf5y1f02a6c0",
      "created": "2020-01-01T00:00:00Z",
      "creator": {
        "email": "mark.joe@zoom.com"
      },
      "organizer": {
        "email": "mark.joe@zoom.com"
      },
      "kind": "calendar#event",
      "updated": "2020-01-01T00:00:00Z"
    }
  ]
}

Content-Type: application/json

Example:

{
  "start": {
    "date": "2020-01-01",
    "dateTime": "2020-01-01T00:00:00Z",
    "timeZone": "America/Los_Angeles"
  },
  "end": {
    "date": "2020-01-01",
    "dateTime": "2020-01-01T00:00:00Z",
    "timeZone": "America/Los_Angeles"
  },
  "attendees": [
    {
      "additionalGuests": 1,
      "displayName": "Mark Joe",
      "email": "mark.joe@zoom.com",
      "optional": false,
      "resource": false,
      "responseStatus": "needsAction"
    }
  ],
  "colorId": "5",
  "description": "event description",
  "guestsCanInviteOthers": true,
  "guestsCanModify": false,
  "guestsCanSeeOtherGuests": true,
  "location": "San Jose",
  "recurrence": [
    "RRULE:FREQ=DAILY;COUNT=2;INTERVAL=3"
  ],
  "reminders": {
    "useDefault": false,
    "overrides": [
      {
        "method": "email",
        "minutes": 5
      }
    ]
  },
  "status": "confirmed",
  "summary": "event title",
  "transparency": "transparent",
  "visibility": "default",
  "id": "0lyk1qjjd8t8thnf5y1f02a6c0",
  "created": "2020-01-01T00:00:00Z",
  "creator": {
    "email": "mark.joe@zoom.com"
  },
  "organizer": {
    "email": "mark.joe@zoom.com"
  },
  "kind": "calendar#event",
  "updated": "2020-01-01T00:00:00Z"
}

• timeMax (required)

  string, format: date-time — The end of the interval for the query.

• timeMin (required)

  string, format: date-time — The start of the interval for the query.

• calendarExpansionMax

  integer — The maximum number of calendars for which FreeBusy information is to be provided.

• groupExpansionMax

  integer — The maximum number of calendar identifiers to be provided for a single group.

• items

  array — The list of calendars and/or groups to query.

  Items:

  • id

    string, format: email — The identifier of a calendar or a group.

• timeZone

  string — The time zone in the response.

Content-Type: application/json

Example:

{
  "kind": "calendar#freeBusy",
  "timeMin": "2024-01-01T00:00:00Z",
  "timeMax": "2024-02-01T00:00:00Z",
  "calendars": [
    {
      "id": "abc.def@zoom.com",
      "errors": [
        {
          "domain": "global",
          "reason": "notFound"
        }
      ],
      "busy": [
        {
          "start": "2024-01-20T17:00:00Z",
          "end": "2024-01-20T18:00:00Z"
        }
      ]
    }
  ],
  "groups": [
    {
      "id": "abc.group@zoom.com",
      "errors": {
        "domain": "global",
        "reason": "notFound"
      },
      "calendars": [
        ""
      ]
    }
  ]
}

Content-Type: application/json

Example:

{
  "kind": "calendar#settings",
  "etag": "\"00000000000000000000\"",
  "nextPageToken": "displaySecondaryTimezone",
  "items": [
    {
      "id": "autoAddZoomMeeting",
      "value": "false"
    }
  ]
}

Content-Type: application/json

Example:

{
  "id": "autoAddZoomMeeting",
  "value": "false"
}

• id (required)

  string — The target setting ID to patch.

• value (required)

  string — The target setting value to patch.

Content-Type: application/json

Example:

{
  "id": "timezone",
  "value": "Asia/Shanghai"
}