v1

latestOpenAPI 3.0.1raw.githubusercontent.com2026-04-2099201202.6 KB
InboxesEvents

List Inbox Events

List label change events for an inbox. Returns events in reverse chronological order by default. Use for IMAP UID projection or audit logging.

CLI:

agentmail inboxes:events list --inbox-id <inbox_id>
get/v0/inboxes/{inbox_id}/events

Path parameters

inbox_idstring required

The ID of the inbox.

Query parameters

limitinteger

Limit of number of items returned.

page_tokenstring

Page token for pagination.

ascendingboolean

Sort in ascending temporal order.

Response

countinteger required

Number of items returned.

limitinteger

Limit of number of items returned.

next_page_tokenstring

Page token for pagination.