AGagentmail-to
inboxes > calendar

Get Agenda

Changed on

Lists every date on the calendar in a time window, ordered by start time: one-off events, and recurring events expanded into their individual dates, with cancelled dates left out. Use it to answer "what is on the calendar".

The window defaults to now through 90 days from now and can be at most 366 days. Items omit description, metadata and attendees; get an event by ID for the full object. An item the inbox is invited to still carries response_status, so needs_action marks an invitation waiting for a reply. Dates of recurring events appear only up to about 90 days from now; use List Event Instances for a recurring event's later dates. While a recurring event's dates are being regenerated after a schedule change, which takes a few seconds, the agenda can briefly leave out some of them; dates that have already started or ended stay as they ran.

The agenda is read in the region that serves the request, so it 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/agenda

Request

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

Path parameters

inbox_idstring required

The ID of the inbox.

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