Search Events

Search for an event in your Google Calendar account.

Options

Field Definition Type Required
Calendar A dropdown list of your available calendars in which to search for a calendar event. Dropdown TRUE
Result Set

Choose one of:

  • First Event: Returns the first event in the search results.
  • All Events: Returns all events from the search results.
Dropdown TRUE

Input

Field Definition Type Required
Event
Query Free text search terms to find events that match these terms in any field, except for extended properties. String FALSE
Order By

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

Dropdown FALSE
Show Deleted Indicates whether to include deleted events (with status equals canceled) in the result. Dropdown FALSE
Show Hidden Invitations Indicates whether to include hidden invitations in the result. Dropdown FALSE
Single Events Indicates 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. Dropdown FALSE
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. String FALSE
Max Attendees Maximum number of attendees to include in the search. Number FALSE
Private Extended Property Extended properties constraint specified as propertyName=value. Matches only private properties. String FALSE
Shared Extended Property Extended properties constraint specified as propertyName=value. Matches only shared properties. String FALSE
Time Min 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. Date & Time FALSE
Time Max 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. Date & Time FALSE
Updated Min Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. Date & Time FALSE
Time Zone Time zone in the format:
  • UTC+-HH
  • GMT+-HH
  • CEST+-HH (Central European Summer Time)
  • EEST+-HH (Eastern European Summer Time)
Date & Time FALSE
Note

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

Output

Field Definition Type
Fields
Type Type of the event. This will most often return as calendar#event given that this is a calendar event. String
Event ID Unique ID of the event from which you want to get information. String
Status

Status of the event. Possible values are:

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

  • tentative - The event is tentatively confirmed

  • canceled - The event is canceled

String
Html Link An absolute link to this event in the Google Calendar Web UI. Read-only. String
Created Time 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. String
Updated Time 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. String
Summary Headline of the name for the calendar event. String
Description Description of the event with details included for attendees. String
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. String

 

Note

ICalUID and 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 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. String
End Time 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. String
Location Geographic location of the event as free-form text. String
Attendee Emails

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.

String
Reminders
Method Method by which a reminder is sent; options are popup or email. String
Minutes Amount of minutes that need to elapse before the reminder is issued; range is from 1 to 40320. String

Related topics

Google Calendar connector

About the elements of Okta Workflows

G Suite API documentation