v34

latestOpenAPI 3.0.1raw.githubusercontent.com2026-07-21119235265.2 KB

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.