List events
list_eventsRetrieve calendar events with details like attendees, status, and hangout links. Filter by time range or search text, expand recurring events, and paginate results.
Instructions
Lists events on a calendar: id, summary, start/end (all-day events carry date with an EXCLUSIVE end; timed events carry dateTime), status, attendees with responseStatus, organizer, recurrence, hangoutLink, eventType. time_min/time_max bound the window (an event overlapping the window is included). single_events=true expands recurring events into individual instances — required for order_by=start_time and the right choice for questions like "what is on my calendar this week"; without it recurring events appear once as the series master. time_zone only changes how times are RENDERED in the response, never the events themselves. q searches summary/description/location/attendees. updated_min + show_deleted enable incremental polling (cancelled events come back as status=cancelled). Paginate with page_token from nextPageToken.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Free-text search over summary, description, location and attendees. | |
| order_by | No | Sort order; start_time works only with single_events=true. Default is unspecified order. | |
| time_max | No | Only events starting before this RFC3339 moment (window upper bound, exclusive). | |
| time_min | No | Only events ending at/after this RFC3339 moment (window lower bound). | |
| time_zone | No | IANA zone the response times are rendered in (defaults to the calendar's zone). | |
| page_token | No | nextPageToken from the previous page. | |
| calendar_id | Yes | The calendar id from list_calendars, or "primary" for the authenticated user's main calendar. | |
| event_types | No | Only these event types (e.g. ["out_of_office"] to see OOO blocks). | |
| max_results | No | Max events per page (1..2500; API default 250). | |
| updated_min | No | Only events modified after this RFC3339 moment — for incremental polling; too-old values return HTTP 410. | |
| show_deleted | No | Include cancelled events (status=cancelled). | |
| single_events | No | Expand recurring events into instances (required for order_by=start_time). |