List Inbox Events | AgentMail

from agentmail import AgentMail
client = AgentMail(
    api_key="YOUR_TOKEN_HERE",
)
client.inboxes.events.list(
    inbox_id="inbox_id",
)

{
  "count": 1,
  "events": [
    {
      "organization_id": "organization_id",
      "pod_id": "pod_id",
      "inbox_id": "inbox_id",
      "event_id": "event_id",
      "event_type": "label_added",
      "message_id": "message_id",
      "label": "label",
      "event_at": "2024-01-15T09:30:00Z",
      "created_at": "2024-01-15T09:30:00Z"
    },
    {
      "organization_id": "organization_id",
      "pod_id": "pod_id",
      "inbox_id": "inbox_id",
      "event_id": "event_id",
      "event_type": "label_added",
      "message_id": "message_id",
      "label": "label",
      "event_at": "2024-01-15T09:30:00Z",
      "created_at": "2024-01-15T09:30:00Z"
    }
  ],
  "limit": 1,
  "next_page_token": "next_page_token"
}

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>

List label change events for an inbox. Returns events in reverse chronological order by default. Use for IMAP UID projection or audit logging. **CLI:** ```bash agentmail inboxes:events list --inbox-id <inbox_id> ```

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

Limit of number of items returned.

page_tokenstringOptional

Page token for pagination.

ascendingbooleanOptional

Sort in ascending temporal order.

Response

This endpoint returns an object.

countinteger

Number of items returned.

eventslist of objects

Ordered by event_id descending.

limitinteger

Limit of number of items returned.

next_page_tokenstring

Page token for pagination.

Errors

404

Not Found Error