inboxes > calendar

Lists the events stored on the calendar: one item per one-off or recurring event, plus one item for each edited date of a recurring event (as that dated event, with is_exception: true). Ordered by most recently updated, and cancelled events are included. Use it to sync or manage what you created. To see what is on the calendar in a time window, use Get Agenda.

The list is always read in the region that serves the request, so it can trail a change made moments earlier by a few seconds. 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

Request

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

Path parameters

inbox_idstring required

The ID of the inbox.

Query parameters

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