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 these options.
|
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. |
Text |
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. This is used to uniquely identify events across calendaring systems and must be supplied when importing events through the import method. |
Text |
FALSE |
|
Max Attendees |
Maximum number of attendees to include in the search. |
Number |
FALSE |
|
Private Extended Property |
The extended properties constraint, specified as propertyName=value. Matches only private properties. |
Text |
FALSE |
|
Shared Extended Property |
The extended properties constraint, specified as propertyName=value. Matches only shared properties. |
Text |
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 an RFC3339 timestamp) to filter by. |
Date & Time |
FALSE |
|
Time Zone |
Time zone in the format:
|
Date & Time |
FALSE |
If input fields are left blank, the search results return all calendar events.
Output
| Field | Definition | Type |
|---|---|---|
|
Fields |
||
|
Type |
Type of the event. This is often returned as calendar#event as this is a calendar event. |
Text |
|
Event ID |
Unique ID of the event from which you want to get information. |
Text |
|
Status |
Status of the event.
|
Text |
|
Html Link |
An absolute link to this event in the Google Calendar Web UI. Read-only. |
Text |
|
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 time zone offset. |
Text |
|
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 time zone offset. |
Text |
|
Summary |
Headline of the name for the calendar event. |
Text |
|
Description |
Description of the event with details included for attendees. |
Text |
|
ICalUID |
Event unique identifier as defined in RFC5545. This is used to uniquely identify events across calendaring systems and must be supplied when importing events through the import method. ICalUID and id aren't identical and only one of them should be supplied at event creation time. One semantic difference is that for recurring events, all occurrences of one event have different id values but they all have the same ICalUID. |
Text |
|
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 time zone offset. |
Text |
|
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 time zone offset. |
Text |
|
Location |
Geographic location of the event as free-form text. |
Text |
|
Attendee Emails |
Email addresses of guests that are invited to the event. This field can be left blank. The event appears on the calendar where it was created. |
Text |
|
Reminders |
||
|
Method |
The method by which a reminder is sent. Options are popup or email. |
Text |
|
Minutes |
Number of minutes that need to elapse before the reminder is issued. The range is from 1 to 40320. |
Text |