list
Returns events on the specified calendar.
Synopsis
Implements the API documented at https://developers.google.com/calendar/api/v3/reference/events/list
gsm events list [flags]
Options
--calendarId string 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. (default "primary")
--fields string Fields allows partial responses to be retrieved.
See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
-h, --help help for list
--iCalUID string ICalUID sets the optional parameter "iCalUID": Specifies event ID in the iCalendar format to be included in the response.
--maxAttendees int 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.
--orderBy string The order of the events returned in the result. Optional. The default is an unspecified, stable order.
Acceptable values are:
startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)
updated - Order by last modification time (ascending).
--privateExtendedProperty strings Properties that are private to the copy of the event that appears on this calendar.
--q string Free text search terms to find events that match these terms in any field, except for extended properties.
--sharedExtendedProperty strings Properties that are shared between copies of the event on other attendees' calendars.
--showDeleted 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.
--showHiddenInvitations Whether to include hidden invitations in the result.
--singleEvents 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.
--timeMax string Upper bound (exclusive) for an event's start time to filter by.
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.
--timeMin string Lower bound (exclusive) for an event's end time to filter by.
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.
--timeZone string Time zone used in the response. Optional.
The default is the time zone of the calendar.
--updatedMin string 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.
Options inherited from parent commands
--compressOutput By default, GSM outputs "pretty" (indented) objects. By setting this flag, GSM's output will be compressed. This may or may not improve performance in scripts.
--config string config file (default is $HOME/.config/gsm/.gsm.yaml)
--delay int This delay (plus a random jitter between 0 and 50) will be applied after every command to avoid reaching quota and rate limits. Set to 0 to disable.
--dwdSubject string Specify a subject used for DWD impersonation (overrides value in config file)
--log string Set the path of the log file. Default is either ~/gsm.log or defined in your config file
--maxElapsedTime int This is the maximum total time that will be spent retrying a request in minutes. (default 15)
--maxRetryInterval int This is the maximum interval that will be used between retry attempts in seconds. (default 320)
--redirectPort int This is the TCP port on which GSM will create web server if you authenticate with a user account for the first time. This is necessary for the OAuth flow. See https://developers.google.com/identity/protocols/oauth2/native-app#redirect-uri_loopback (default 8081)
--retryOn ints Specify the HTTP error code(s) that GSM should retry on. Note that GSM will always retry on HTTP 403 errors that indicate a quota / rate limit error
--streamOutput Setting this flag will cause GSM to output slice values to stdout one by one, instead of one large object
SEE ALSO
- gsm events - Manage events in users’ calendars (Part of Calendar API)
- gsm events list batch - Batch lists events using a CSV file as input.