Sign in
InboxesMessages

Batch Get Messages

Fetch metadata for up to 500 messages in one request. Missing or restricted IDs are silently omitted; compare count against limit to detect misses.

CLI:

agentmail inboxes:messages batch-get --inbox-id <inbox_id> --message-id <id1> --message-id <id2>
post/v0/inboxes/{inbox_id}/messages/batch-get

Path parameters

inbox_idstring required

The ID of the inbox.

Request body

message_idsMessageId[] required

IDs of messages to fetch. Maximum 500 ids per request. Duplicates are rejected with a validation error. IDs not found in the inbox (including cross-inbox or permission-restricted) are silently omitted from the response; callers detect misses by comparing count against limit.

Response

limitinteger required

Limit of number of items returned.

countinteger required

Number of items returned.

Changes

Changed in 2 of the 34 revisions of this API.5

  • 394ddcdd9c294See the full diff
    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

      added the optional property message to the response with the 400 status

      response-optional-property-added

  • 0e9bf235f08a1See the full diff
    • ○

      endpoint added

      endpoint-added