List Calendar Events
shipmail_list_calendar_eventsRetrieve calendar events for a mailbox within a specified time range. Optionally expand recurring events into individual instances.
Instructions
List calendar events in a time range for one mailbox. Set expand=true to return recurring events as individual instances.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | Yes | End of the time range (UTC instant). | |
| from | Yes | Start of the time range (UTC instant). | |
| limit | No | Maximum results to return. | |
| cursor | No | Pagination cursor returned by the previous call. | |
| expand | No | Expand recurring events into individual instances. | |
| mailbox | Yes | The mailbox (calendar owner) address. | |
| calendar_id | No | Restrict to a single calendar. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | ||
| pagination | Yes |