AGagentmail-to
inboxes > messages

Batch Get Messages

Changed on

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-ids <id1> --message-ids <id2>
post/v0/inboxes/{inbox_id}/messages/batch-get

Request

Path parameters

inbox_idstring required

The ID of the inbox.

Request body

message_idsMessagesMessageId[] 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

Response with status 200

limitinteger required

Limit of number of items returned.

countinteger required

Number of items returned.

Changes

  • 2a1b3691835dRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 3f5c7830c952Revision changes
    • info

      the endpoint scheme security Bearer was added to the API

    • info

      the endpoint scheme security BearerAuth was removed from the API

    • info

      api tag inboxes > messages added

    • info

      api tag InboxesMessages removed

    • info

      request body became optional

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status