Skip to navigation
API ReferenceInboxesCalendar

Get Calendar

Beta

Gets the inbox’s calendar. Every inbox has one calendar, so this works before any event is created. Its etag (also the ETag response header) is the value to send in If-Match to make an update conditional.

Requires the calendar_read permission. Calendar is in private beta in US production (api.agentmail.to) and 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

consistencyenumOptional

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.

Allowed values:

Response

This endpoint returns an object.
inbox_idstring
The ID of the inbox.
timezonestring

Default time zone for events created without a timezone. Defaults to UTC. Changing it does not move existing events.

event_countinteger

Number of one-off and recurring events on the calendar. Each recurring event counts once.

created_atdatetime
Time at which the calendar was created. The calendar exists from the moment the inbox does, so this is the inbox's creation time.
updated_atdatetime
Time at which the calendar was last updated.
etagstring

The calendar's current version, also sent as the ETag response header. Send it in If-Match to make an update conditional.

Errors

400
Validation Error
403
Forbidden Error
404
Not Found Error