List Messages
Lists messages in the inbox, most recent first. Pass from, to, or subject to filter by substring. Filtered requests are served by search, which caps limit at 100. For relevance-ranked full-text search across sender, recipients, subject, and message body, use Search Messages.
CLI:
agentmail inboxes:messages list --inbox-id <inbox_id>
Path parameters
The ID of the inbox.
Query parameters
Limit of number of items returned.
Page token for pagination.
Labels to filter by.
Timestamp before which to filter by.
Timestamp after which to filter by.
Sort in ascending temporal order.
Include spam in results.
Include blocked in results.
Include unauthenticated in results.
Include trash in results.
Filter to messages whose sender contains this value (substring match). Repeatable; all values must match.
Filter to messages whose recipients (to, cc, or bcc) contain this value (substring match). Repeatable; all values must match.
Filter to messages whose subject contains this value (substring match). Repeatable; all values must match.
Response
Changes
Changed in 5 of the 34 revisions of this API.211
- ○
added the new optional
queryrequest parameterfromnew-optional-request-parameter
- ○
added the new optional
queryrequest parametersubjectnew-optional-request-parameter
- ○
added the new optional
queryrequest parametertonew-optional-request-parameter
- ○
added the optional property
codeto the response with the404statusresponse-optional-property-added
- ○
added the optional property
docsto the response with the404statusresponse-optional-property-added
- ○
added the optional property
fixto the response with the404statusresponse-optional-property-added
- ○
- ○
added the new optional
queryrequest parameterinclude_unauthenticatednew-optional-request-parameter
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ○
added the new optional
queryrequest parameterinclude_blockednew-optional-request-parameter
- ○
added the new optional
queryrequest parameterinclude_trashnew-optional-request-parameter
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ●
deleted the
queryrequest parameterinclude_blockedrequest-parameter-removed
- ●
deleted the
queryrequest parameterinclude_trashrequest-parameter-removed
This revision also has 28 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ○
added the new optional
queryrequest parameterinclude_blockednew-optional-request-parameter
- ○
added the new optional
queryrequest parameterinclude_trashnew-optional-request-parameter
- ○