Search Events

Search for an event in your Google Calendar account.

Unless otherwise indicated, field types are text.

Required fields are indicated by a red asterisk on the Action Card.

Options

  • Calendar (dropdown): A dropdown list of your available calendars in which to search for a calendar event.

  • Result Set (dropdown):

    • First Event: Returns the first event in the search results.

    • All Events Returns all events from the search results.

Input Fields

  • Event

    • Query: Free text search terms to find events that match these terms in any field, except for extended properties.

    • Order By (dropdown):

      • Start Time: Order by an event's start date and time (ascending). Only for when querying single events.

      • Updated: Order by last modification time (ascending).

    • Show Deleted (dropdown): Whether to include deleted events (with status equals "canceled") in the result.

    • Show Hidden Invitations (dropdown): Whether to include hidden invitations in the result.

    • Single Events (dropdown): 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.

    • ICalUID: 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.

    • Max Attendees (number): The maximum number of attendees to include in the search.

    • Private Extended Property: Extended properties constraint specified as propertyName=value. Matches only private properties.

    • Shared Extended Property: Extended properties constraint specified as propertyName=value. Matches only shared properties.

    • Time Min (date and time): The date and time from which you want to check if your calendar is available. Input needs to be in the format YYYY-MM-DDTHH:MM:SSZ.

    • Time Max (date and time): The date and time before which you want to check if your calendar is available. Input needs to be in the format YYYY-MM-DDTHH:MM:SSZ.

    • Updated Min (date and time): Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by.

    • Time Zone (date): Time zone in the format:

      • UTC+-HH

      • GMT+-HH

      • CEST+-HH (Central European Summer Time)

      • EEST+-HH (Eastern European Summer Time)

Note: If input fields are left blank, the search results will return all calendar events.

Output Fields

  • Fields

    • Type: The type of the event - will most often return as "calendar#event" given that this is a calendar event.

    • Event ID: Unique ID of the event from which you want to get information.

    • Status: Status of the event. Optional. Possible values are:

      • confirmed - The event is confirmed. This is the default status.

      • tentative - The event is tentatively confirmed.

      • canceled - The event is cancelled.

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

    • Created Time: The date and time at which the event was created in ISO format: YYYY-MM-DDThh:mm:ss+00:00. The +00:00 is the timezone offset.

    • Updated Time: The date and time at which the event was last updated in ISO format: YYYY-MM-DDThh:mm:ss+00:00. The +00:00 is the timezone offset.

    • Summary: The headline of the name for the calendar event.

    • Description: The description of the event with details included for attendees to see.

    • ICalUID: 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.
    • Start Time: The date and time at which you want the event to start in ISO format: YYYY-MM-DDThh:mm:ss+00:00. The +00:00 is the timezone offset.

    • End Time: The date and time at which you want the event to end in ISO format: YYYY-MM-DDThh:mm:ss+00:00. The +00:00 is the timezone offset.

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

    • Attendee Emails: The email addresses of guests that are invited to the event. This field can be left blank. NOTE: The event will be on the calendar through which it was created.

    • Reminders

      • Method: Method by which a reminder is sent; options are popup or email.

      • Minutes: Amount of minutes that need to elapse before the reminder is issued; range is from 1 to 40320.