AGagentmail-to
inboxes > calendar

List Event Instances

Changed on

Lists the dates of one recurring event in a time window, in start order, with each date's edits applied. Dates are computed from the rule, so this works for any window up to 366 days, including dates far in the future. Cancelled dates are left out.

The window defaults to now through 90 days from now. Items omit description, metadata and attendees; get a date by its ID for the full object. Like other reads, the list can trail a change made moments earlier by a few seconds; pass consistency=primary to read your own change right away. Requires the calendar_event_read permission.

Calendar is available in US production (api.agentmail.to) but not yet in EU production (api.agentmail.eu), which returns 403.

get/v0/inboxes/{inbox_id}/calendar/events/{event_id}/instances

Request

  • Base URL
    https://api.agentmail.to
  • URL
    https://api.agentmail.to/v0/inboxes/{inbox_id}/calendar/events/{event_id}/instances
  • Auth
    HTTP bearer

Path parameters

inbox_idstring required

The ID of the inbox.

event_idstring required

UUID of the recurring event.

Query parameters

consistency'eventual' | 'primary'

Read consistency. eventual (default) reads from the region that serves your request and may lag a write made moments earlier by up to a few seconds. primary reads from the primary region and always reflects every completed write.

afterstring date-time

Start of the window, as a UTC timestamp ending in Z (an offset such as -04:00 is rejected). Defaults to now. The window between after and before can be at most 366 days.

beforestring date-time

End of the window, as a UTC timestamp ending in Z (an offset such as -04:00 is rejected). Defaults to 90 days after after. The window between after and before can be at most 366 days.

include_overlappingboolean

When true (default), include events that started before after but are still running at after. When false, include only events that start inside the window.

limitinteger

Maximum number of events to return, from 1 to 100. Defaults to 50.

page_tokenstring

Page token for pagination.

Response

Response with status 200

countinteger required

Number of items returned.

limitinteger required

Limit of number of items returned.

next_page_tokenstring

Page token for pagination.

Changes