Skip to navigation

List Events

Beta

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 in private beta in US production (api.agentmail.to). It is unavailable in EU production (api.agentmail.eu). Organizations without access receive a 403.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

inbox_idstringRequired
The ID of the inbox.

Query parameters

limitintegerOptional
Maximum number of events to return, from 1 to 100. Defaults to 50.
page_tokenstringOptional
Page token for pagination.

Response

This endpoint returns an object.
countinteger
Number of items returned.
limitinteger
Limit of number of items returned.
eventslist of objects

On List Events, ordered by updated_at descending. On Get Agenda and List Event Instances, ordered by start_at ascending.

next_page_tokenstringOptional
Page token for pagination.

Errors

400
Validation Error
403
Forbidden Error
404
Not Found Error