Skip to main content
GET
List Inbox Events
Lists delivery and activity events for one inbox — the audit trail behind sends and receipts. Returns count, limit, next_page_token and events; page with next_page_token. Each event carries event_id, event_type, message_id, label, event_at and inbox_id. Use this to find out what happened to a message after post_agentmail_inbox_message_send returned, which the send call itself cannot tell you. For aggregate counts rather than individual events use get_agentmail_inbox_metrics.

Example

Authorizations

Authorization
string
header
required

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

Headers

Authorization
string
required

Bearer authentication

Path Parameters

inbox_id
string
required

The ID of the inbox.

Query Parameters

limit
integer

Limit of number of items returned.

page_token
string

Page token for pagination.

ascending
boolean

Sort in ascending temporal order.

Response

Response with status 200

count
integer
required

Number of items returned.

events
InboxEvent · object[]
required

Ordered by event_id descending.

limit
integer

Limit of number of items returned.

next_page_token
string

Page token for pagination.