Calendar.events.list

Returns events on the specified calendar.

GET/calendars/{calendarId}/events

Use it in a workflow

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

Request

Path parameters

calendarIdstringrequired

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.

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.

alwaysIncludeEmailboolean

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

eventTypesarray<string>

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.

iCalUIDstring

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.

maxAttendeesinteger

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.

maxResultsinteger

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.

orderBystring

The order of the events returned in the result. Optional. The default is an unspecified, stable order.

One ofstartTimeupdated

pageTokenstring

Token specifying which result page to return. Optional.

privateExtendedPropertyarray<string>

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.

qstring

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.

sharedExtendedPropertyarray<string>

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.

showDeletedboolean

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.

showHiddenInvitationsboolean

Whether to include hidden invitations in the result. Optional. The default is False.

singleEventsboolean

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.

syncTokenstring

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.

timeMaxstring

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.

timeMinstring

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.

timeZonestring

Time zone used in the response. Optional. The default is the time zone of the calendar.

updatedMinstring

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.

Response

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

accessRolestring

The user's access role for this calendar. Read-only. Possible values are: - "none" - The user has no access. - "freeBusyReader" - The user has read access to free/busy information. - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - The user has read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - The user has ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

defaultRemindersarray<object>

The default reminders on the calendar for the authenticated user. These reminders apply to all events on this calendar that do not explicitly override them (i.e. do not have reminders.useDefault set to True).

methodstring

The method used by this reminder. Possible values are: - "email" - Reminders are sent via email. - "popup" - Reminders are sent via a UI popup. Required when adding a reminder.

minutesinteger (int32)

Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes). Required when adding a reminder.

descriptionstring

Description of the calendar. Read-only.

etagstring

ETag of the collection.

itemsarray<object>

List of events on the calendar.

anyoneCanAddSelfboolean

Whether anyone can invite themselves to the event (deprecated). Optional. The default is False.

Default false

attachmentsarray<object>5 fields

File attachments for the event. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event,

attendeesarray<object>10 fields

The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.

attendeesOmittedboolean

Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.

Default false

colorIdstring

The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.

conferenceDataobject7 fields

createdstring (date-time)

Creation time of the event (as a RFC3339 timestamp). Read-only.

creatorobject4 fields

The creator of the event. Read-only.

descriptionstring

Description of the event. Can contain HTML. Optional.

endobject3 fields

endTimeUnspecifiedboolean

Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.

Default false

etagstring

ETag of the resource.

eventTypestring

Specific type of the event. Read-only. Possible values are: - "default" - A regular event or not further specified. - "outOfOffice" - An out-of-office event. - "focusTime" - A focus-time event. - "workingLocation" - A working location event. Developer Preview.

Default "default"

extendedPropertiesobject2 fields

Extended properties of the event.

gadgetobject8 fields

A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

guestsCanInviteOthersboolean

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

Default true

guestsCanModifyboolean

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

Default false

guestsCanSeeOtherGuestsboolean

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

Default true

hangoutLinkstring

An absolute link to the Google Hangout associated with this event. Read-only.

htmlLinkstring

An absolute link to this event in the Google Calendar Web UI. Read-only.

iCalUIDstring

Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method. Note that the iCalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same iCalUIDs. To retrieve an event using its iCalUID, call the events.list method using the iCalUID parameter. To retrieve an event using its id, call the events.get method.

idstring

Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 - the length of the ID must be between 5 and 1024 characters - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. If you do not specify an ID, it will be automatically generated by the server. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

kindstring

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

Default "calendar#event"

locationstring

Geographic location of the event as free-form text. Optional.

lockedboolean

Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.

Default false

organizerobject4 fields

The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event.

originalStartTimeobject3 fields

privateCopyboolean

If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False.

Default false

recurrencearray<string>

List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.

recurringEventIdstring

For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

remindersobject2 fields

Information about the event's reminders for the authenticated user.

sequenceinteger (int32)

Sequence number as per iCalendar.

sourceobject2 fields

Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.

startobject3 fields

statusstring

Status of the event. Optional. Possible values are: - "confirmed" - The event is confirmed. This is the default status. - "tentative" - The event is tentatively confirmed. - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. A cancelled status represents two different states depending on the event type: - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely. Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details. If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.

summarystring

Title of the event.

transparencystring

Whether the event blocks time on the calendar. Optional. Possible values are: - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

Default "opaque"

updatedstring (date-time)

Last modification time of the event (as a RFC3339 timestamp). Read-only.

visibilitystring

Visibility of the event. Optional. Possible values are: - "default" - Uses the default visibility for events on the calendar. This is the default value. - "public" - The event is public and event details are visible to all readers of the calendar. - "private" - The event is private and only event attendees may view event details. - "confidential" - The event is private. This value is provided for compatibility reasons.

Default "default"

workingLocationPropertiesobject3 fields

kindstring

Type of the collection ("calendar#events").

Default "calendar#events"

nextPageTokenstring

Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.

nextSyncTokenstring

Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.

summarystring

Title of the calendar. Read-only.

timeZonestring

The time zone of the calendar. Read-only.

updatedstring (date-time)

Last modification time of the calendar (as a RFC3339 timestamp). Read-only.

json

{
  "accessRole": "string",
  "defaultReminders": [
    {
      "method": "string",
      "minutes": 0
    }
  ],
  "description": "string",
  "etag": "string",
  "items": [
    {
      "anyoneCanAddSelf": false,
      "attachments": [
        {
          "fileId": "string",
          "fileUrl": "string",
          "iconLink": "string",
          "mimeType": "string",
          "title": "string"
        }
      ],
      "attendees": [
        {
          "additionalGuests": 0,
          "comment": "string",
          "displayName": "string",
          "email": "string",
          "id": "string",
          "optional": false,
          "organizer": false,
          "resource": false,
          "responseStatus": "string",
          "self": false
        }
      ],
      "attendeesOmitted": false,
      "colorId": "string",
      "conferenceData": {
        "conferenceId": "string",
        "conferenceSolution": {
          "iconUri": "string",
          "key": {
            "type": "string"
          },
          "name": "string"
        },
        "createRequest": {
          "conferenceSolutionKey": {
            "type": "string"
          },
          "requestId": "string",
          "status": {
            "statusCode": "string"
          }
        },
        "entryPoints": [
          {
            "accessCode": "string",
            "entryPointFeatures": [
              null
            ],
            "entryPointType": "string",
            "label": "string",
            "meetingCode": "string",
            "passcode": "string",
            "password": "string",
            "pin": "string",
            "regionCode": "string",
            "uri": "string"
          }
        ],
        "notes": "string",
        "parameters": {
          "addOnParameters": {
            "parameters": {}
          }
        },
        "signature": "string"
      },
      "created": "2025-01-01T00:00:00Z",
      "creator": {
        "displayName": "string",
        "email": "string",
        "id": "string",
        "self": false
      },
      "description": "string",
      "end": {
        "date": "2025-01-01",
        "dateTime": "2025-01-01T00:00:00Z",
        "timeZone": "string"
      },
      "endTimeUnspecified": false,
      "etag": "string"
    }
  ],
  "kind": "calendar#events",
  "nextPageToken": "string",
  "nextSyncToken": "string",
  "summary": "string",
  "timeZone": "string",
  "updated": "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?