Google Calendar - Search events action (batch)

The Search events batch action searches a calendar for events matching the search terms you specify. Partial matches are included in the output list for this action.

ENSURE CALENDAR ACCESS

Ensure the calendar you plan to search is accessible from your connected account and that you have the necessary permissions to view events.

Input

Input fieldDescription
Calendar IDProvide the Google Calendar ID of the calendar to search for events in.
Search termsOptional. Enter terms to search event names and descriptions for. The action returns partial matches in the output list.
Single eventsSelect whether to receive each occurrence of a recurring event as an individual event.
Date fromOptional. Fetch events starting on or after this datetime in the connected account's time zone.
Date toOptional. Fetch events ending on or before this datetime in the connected account's time zone.

Output

Output fieldDefinition
KindThe type of the resource, such as calendar#event.
EtagThe etag for the event.
Color IDThe Google ID for the color attached to the event.
Event import IDThe Google import ID for the event.
IDThe Google ID for the event.
StatusThe status of the event, such as confirmed or cancelled.
URLThe URL for the event.
CreatedA timestamp indicating when the event was created.
UpdatedA timestamp indicating when the event was last updated.
SummaryThe title of the event.
DescriptionThe description of the event.
LocationThe location where the event is taking place.
StartThe start time of the event.
EndThe end time of the event.
RecurrenceThe recurrence rules for the event.
Recurring event IDThe Google ID of the recurring event.
Original start timeContains information about the start time of the event, such as:
  • Date time: The date and time of the event.
  • Time zone: The time zone of the event.
VisibilityThe visibility of the event, such as Public or Private.
RemindersContains information about the event's reminder settings, such as:
  • Use default: Indicates whether the default reminder settings are used.
  • Overrides: Contains specific reminder overrides for this event.
Show me asThe availability to display during the event, such as Busy or Available.
Hangout linkA link to the Google Hangout associated with the event.
SequenceThe sequence number of the event.
Guests can modifyIndicates whether guests can modify the event.
Guests can see other guestsIndicates whether guests can see other guests.
AttachmentsContains information about the event's attachments, such as:
  • File URL: The URL of the attached file.
  • Title: The title of the attachment.
  • Mime type: MIME type of the file.
  • Icon link: A link to the icon representing the file type.
  • File ID: A unique identifier for the file.
  • List size: The number of attachments.
  • List index: The position of this attachment in the list.
AttendeesContains information about the event's attendees, such as:
  • ID: A unique identifier for the attendee.
  • Email: The email address of the attendee.
  • Name: The name of the attendee.
  • Self: Indicates whether the attendee is the user managing the calendar.
  • Response status: The attendee's response status for the event invitation.
  • Comment: Any comment provided by the attendee.
  • List size: The number of attendees in the list.
  • List index: The position of the current attendee in the list.
CreatorContains information about the event's creator, such as:
  • ID: A unique identifier for the creator.
  • Email: The email address of the creator.
  • Name: The name of the creator.
  • Self: Indicates whether the creator is the user managing the calendar.
OrganizerContains information about the event's organizer, such as:
  • ID: A unique identifier for the organizer.
  • Email: The email address of the organizer.
  • Name: The name of the organizer.
  • Self: Indicates whether the organizer is the user managing the calendar.
List sizeThe number of events in the list.
List indexThe position of the current event in the list.

Last updated: