Sign in
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.

Changes

Changed in 3 of the 34 revisions of this API.26

  • 394ddcdd9c293See the full diff
    • ○

      added the optional property code to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property docs to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property fix to the response with the 404 status

      response-optional-property-added

  • 18101510657c22See the full diff
    • ●

      added the new label.added enum value to the events/items/event_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new label.removed enum value to the events/items/event_type response property for the response status 200

      response-property-enum-value-added

    • ○

      removed the label_added enum value from the events/items/event_type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the label_removed enum value from the events/items/event_type response property for the response status 200

      response-property-enum-value-removed

  • e0a11b4391501See the full diff
    • ○

      endpoint added

      endpoint-added