Endpoint List events
Name
list_events
Description
Related Tables
Parameters
| Parameter | Required | Options | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Name:
Label: Calendar ID (e.g. 'primary' or calendar ID) |
YES | |||||||||||
|
Name:
Label: Start Time Lower bound for event start time (RFC3339 timestamp, e.g. 2026-01-26T00:00:00Z --OR-- 2026-01-27T05:00:00-05:00) |
|
|||||||||||
|
Name:
Label: End Time Upper bound for event end time (RFC3339 timestamp, e.g. 2026-01-27T00:00:00Z --OR-- 2026-01-27T05:00:00-05:00) |
|
|||||||||||
|
Name:
Label: Show Deleted Whether to include deleted events (true/false) |
|
|||||||||||
|
Name:
Label: Single Events Expand recurring events into instances (true/false) |
|
|||||||||||
|
Name:
Label: Max Results Maximum number of events per page |
||||||||||||
|
Name:
Label: Order By Order of the events returned (startTime or updated) |
|
Output Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
|---|---|---|---|---|
| Id |
DT_WSTR
|
nvarchar(300)
|
300 | |
| Kind |
DT_WSTR
|
nvarchar(300)
|
300 | |
| Status |
DT_WSTR
|
nvarchar(300)
|
300 | |
| HtmlLink |
DT_WSTR
|
nvarchar(1000)
|
1000 | |
| CreatedAt |
DT_DBTIMESTAMP
|
datetime
|
||
| UpdatedAt |
DT_DBTIMESTAMP
|
datetime
|
||
| Summary |
DT_WSTR
|
nvarchar(300)
|
300 | |
| Description |
DT_NTEXT
|
nvarchar(MAX)
|
||
| CreatorEmail |
DT_WSTR
|
nvarchar(300)
|
300 | |
| OrganizerEmail |
DT_WSTR
|
nvarchar(300)
|
300 | |
| OrganizerDisplayName |
DT_WSTR
|
nvarchar(300)
|
300 | |
| StartsAt |
DT_DBTIMESTAMP
|
datetime
|
||
| StartsOn |
DT_DBDATE
|
date
|
||
| StartTimeZone |
DT_WSTR
|
nvarchar(300)
|
300 | |
| EndsAt |
DT_DBTIMESTAMP
|
datetime
|
||
| EndsOn |
DT_DBDATE
|
date
|
||
| EndTimeZone |
DT_WSTR
|
nvarchar(300)
|
300 | |
| Attendees |
DT_NTEXT
|
nvarchar(MAX)
|
||
| Location |
DT_WSTR
|
nvarchar(1024)
|
1024 | |
| Recurrence |
DT_WSTR
|
nvarchar(1000)
|
1000 | |
| ICalUID |
DT_WSTR
|
nvarchar(300)
|
300 | |
| EventType |
DT_WSTR
|
nvarchar(128)
|
128 | |
| ColorId |
DT_WSTR
|
nvarchar(50)
|
50 | |
| Visibility |
DT_WSTR
|
nvarchar(50)
|
50 | |
| Transparency |
DT_WSTR
|
nvarchar(50)
|
50 | |
| Sequence |
DT_I4
|
int
|
||
| Attachments |
DT_NTEXT
|
nvarchar(MAX)
|
||
| ConferenceDataConferenceId |
DT_WSTR
|
nvarchar(500)
|
500 | |
| ConferenceDataEntryPoints |
DT_WSTR
|
nvarchar(1000)
|
1000 | |
| ConferenceDataConferenceSolutionKeyType |
DT_WSTR
|
nvarchar(500)
|
500 | |
| ConferenceDataConferenceSolutionIconUri |
DT_WSTR
|
nvarchar(500)
|
500 | |
| ConferenceDataConferenceSolutionName |
DT_WSTR
|
nvarchar(500)
|
500 | |
| GuestsCanInviteOthers |
DT_BOOL
|
bit
|
||
| RemindersUseDefault |
DT_BOOL
|
bit
|
||
| RemindersOverrides |
DT_WSTR
|
nvarchar(1000)
|
1000 | |
| ETag |
DT_WSTR
|
nvarchar(200)
|
200 | |
| HangoutLink |
DT_WSTR
|
nvarchar(1000)
|
1000 | |
| RecurringEventId |
DT_WSTR
|
nvarchar(300)
|
300 | |
| OriginalStartDateTime |
DT_DBTIMESTAMP
|
datetime
|
||
| OriginalStartDate |
DT_DBDATE
|
date
|
||
| SourceUrl |
DT_WSTR
|
nvarchar(1024)
|
1024 | |
| SourceTitle |
DT_WSTR
|
nvarchar(300)
|
300 |
Input Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
SSIS
Use Google Calendar Connector in API Source or in API Destination SSIS Data Flow components to read or write data.
API Source
This Endpoint belongs to the Events table, therefore it is better to use it, instead of accessing the endpoint directly:
| Required Parameters | |
|---|---|
| Calendar ID (e.g. 'primary' or calendar ID) | Fill-in the parameter... |
API Destination
This Endpoint belongs to the Events table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to list events:
| Required Parameters | |
|---|---|
| Calendar ID (e.g. 'primary' or calendar ID) | Fill-in the parameter... |
ODBC application
Use these SQL queries in your ODBC application data source:
List events
SELECT * FROM Events
WITH (CalendarId='MyCalendarId') -- Specify the calendar ID to list events from
--Get single event by Id
--SELECT * FROM Events WHERE Id='MyEventId' -- Filter by event ID in WHERE clause
--SELECT * FROM Events WITH(EventId='MyEventId') -- Use EventId parameter for direct lookup
List events with time range
SELECT *
FROM Events
WITH (CalendarId='primary',
StartTime='2026-01-01T00:00:00Z',
EndTime='2026-01-31T23:59:59Z')
--OR-- From all accessible calendars (EventsAll table)
--SELECT *
--FROM EventsAll
--WITH (StartTime='2026-01-01T00:00:00-05:00',
-- EndTime='2026-01-31T23:59:59-05:00')
List events ordered by start time
SELECT *
FROM Events
WITH (CalendarId='primary',
OrderBy='startTime')
List events including deleted ones
SELECT *
FROM Events
WITH (CalendarId='primary',
ShowDeleted='true')
List events with max results and single events
SELECT * FROM Events
WITH (CalendarId='primary',
MaxResults=10,
SingleEvents='true')
List events for next week using dynamic dates
SELECT * FROM Events
--FROM EventsAll --(Get from All Calendars)
WITH (CalendarId='primary',
--//e.g. append -05:00 for EST (New York Time Zone) to convert local time to UTC -OR- just appends "Z" for UTC time (2026-01-01T05:00:00Z which is same as 2026-01-01T00:00:00-05:00 ).
StartTime='<<today,FUN_TO_DATETIME>>-05:00',
EndTime='<<today+7d,FUN_TO_DATETIME>>-05:00')
List events ordered by updated time
SELECT * FROM Events
--FROM EventsAll --(Get from All Calendars)
WITH (CalendarId='primary',
OrderBy='updated')
List events for today and tomorrow with dynamic placeholders
SELECT *
FROM Events
--FROM EventsAll --(Get from All Calendars)
WITH (CalendarId='primary',
StartTime='<<today,FUN_TO_DATETIME>>-05:00',
EndTime='<<today+1d,FUN_TO_DATETIME>>-05:00')
list_events endpoint belongs to
Events
table(s), and can therefore be used via those table(s).
SQL Server
Use these SQL queries in SQL Server after you create a data source in Data Gateway:
List events
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Events
WITH (CalendarId=''MyCalendarId'') -- Specify the calendar ID to list events from
--Get single event by Id
--SELECT * FROM Events WHERE Id=''MyEventId'' -- Filter by event ID in WHERE clause
--SELECT * FROM Events WITH(EventId=''MyEventId'') -- Use EventId parameter for direct lookup';
EXEC (@MyQuery) AT [LS_TO_GOOGLE_CALENDAR_IN_GATEWAY];
List events with time range
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT *
FROM Events
WITH (CalendarId=''primary'',
StartTime=''2026-01-01T00:00:00Z'',
EndTime=''2026-01-31T23:59:59Z'')
--OR-- From all accessible calendars (EventsAll table)
--SELECT *
--FROM EventsAll
--WITH (StartTime=''2026-01-01T00:00:00-05:00'',
-- EndTime=''2026-01-31T23:59:59-05:00'')';
EXEC (@MyQuery) AT [LS_TO_GOOGLE_CALENDAR_IN_GATEWAY];
List events ordered by start time
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT *
FROM Events
WITH (CalendarId=''primary'',
OrderBy=''startTime'')';
EXEC (@MyQuery) AT [LS_TO_GOOGLE_CALENDAR_IN_GATEWAY];
List events including deleted ones
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT *
FROM Events
WITH (CalendarId=''primary'',
ShowDeleted=''true'')';
EXEC (@MyQuery) AT [LS_TO_GOOGLE_CALENDAR_IN_GATEWAY];
List events with max results and single events
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Events
WITH (CalendarId=''primary'',
MaxResults=10,
SingleEvents=''true'')';
EXEC (@MyQuery) AT [LS_TO_GOOGLE_CALENDAR_IN_GATEWAY];
List events for next week using dynamic dates
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Events
--FROM EventsAll --(Get from All Calendars)
WITH (CalendarId=''primary'',
--//e.g. append -05:00 for EST (New York Time Zone) to convert local time to UTC -OR- just appends "Z" for UTC time (2026-01-01T05:00:00Z which is same as 2026-01-01T00:00:00-05:00 ).
StartTime=''<<today,FUN_TO_DATETIME>>-05:00'',
EndTime=''<<today+7d,FUN_TO_DATETIME>>-05:00'')';
EXEC (@MyQuery) AT [LS_TO_GOOGLE_CALENDAR_IN_GATEWAY];
List events ordered by updated time
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Events
--FROM EventsAll --(Get from All Calendars)
WITH (CalendarId=''primary'',
OrderBy=''updated'')';
EXEC (@MyQuery) AT [LS_TO_GOOGLE_CALENDAR_IN_GATEWAY];
List events for today and tomorrow with dynamic placeholders
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT *
FROM Events
--FROM EventsAll --(Get from All Calendars)
WITH (CalendarId=''primary'',
StartTime=''<<today,FUN_TO_DATETIME>>-05:00'',
EndTime=''<<today+1d,FUN_TO_DATETIME>>-05:00'')';
EXEC (@MyQuery) AT [LS_TO_GOOGLE_CALENDAR_IN_GATEWAY];
list_events endpoint belongs to
Events
table(s), and can therefore be used via those table(s).