> ## Documentation Index > Fetch the complete documentation index at: https://agentmail.manicule.dev/llms.txt > Use this file to discover all available pages before exploring further. > For every page in one file, fetch https://agentmail.manicule.dev/llms-full.txt (large). > To search and read these docs as tools, connect the MCP server at https://agentmail.manicule.dev/api/mcp. > Every agent surface: https://agentmail.manicule.dev/.well-known/llms-manifest.json # Batch Get Messages (/api-reference/batch-get-messages) Related: [Sign Up](/api-reference/sign-up.md), [Attach Human](/api-reference/attach-human.md), [Verify](/api-reference/verify.md), [List Inboxes](/api-reference/list-inboxes.md), [Create Inbox](/api-reference/create-inbox.md), [Search Inboxes](/api-reference/search-inboxes.md) # Batch Get Messages `POST /v0/inboxes/{inbox_id}/messages/batch-get` > 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:** > ```bash > agentmail inboxes messages batch-get --inbox-id --message-ids --message-ids > ``` Base URL: `https://api.agentmail.to` Base URL: `https://x402.api.agentmail.to` Base URL: `https://mpp.api.agentmail.to` Base URL: `https://api.agentmail.eu` ## OpenAPI ```json { "servers": [ { "url": "https://api.agentmail.to", "description": "prod" }, { "url": "https://x402.api.agentmail.to", "description": "prod-x402" }, { "url": "https://mpp.api.agentmail.to", "description": "prod-mpp" }, { "url": "https://api.agentmail.eu", "description": "eu-prod" } ], "security": [ { "Bearer": [] } ], "securitySchemes": { "Bearer": { "type": "http", "scheme": "bearer" } }, "parameters": [ { "name": "inbox_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the inbox.", "title": "InboxId" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message_ids": { "type": "array", "items": { "type": "string", "description": "ID of message.", "title": "MessageId" }, "description": "IDs of messages to fetch. Maximum 500 ids per request. Duplicates are\nrejected with a validation error. IDs not found in the inbox (including\ncross-inbox or permission-restricted) are silently omitted from the\nresponse; callers detect misses by comparing `count` against `limit`.", "title": "BatchGetMessagesMessageIds" } }, "required": [ "message_ids" ], "title": "BatchGetMessagesRequest" } } } }, "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Limit of number of items returned.", "title": "Limit" }, "count": { "type": "integer", "description": "Number of items returned.", "title": "Count" }, "messages": { "type": "array", "items": { "type": "object", "properties": { "inbox_id": { "type": "string", "description": "The ID of the inbox.", "title": "InboxId" }, "thread_id": { "type": "string", "description": "ID of thread.", "title": "ThreadId" }, "message_id": { "type": "string", "description": "ID of message.", "title": "MessageId" }, "labels": { "type": "array", "items": { "type": "string" }, "description": "Labels of message.", "title": "MessageLabels" }, "timestamp": { "type": "string", "format": "date-time", "description": "Time at which message was sent or drafted.", "title": "MessageTimestamp" }, "from": { "type": "string", "description": "Address of sender. In format `username@domain.com` or `Display Name `.", "title": "MessageFrom" }, "reply_to": { "type": "array", "items": { "type": "string" }, "description": "Reply-to addresses. In format `username@domain.com` or `Display Name `." }, "to": { "type": "array", "items": { "type": "string" }, "description": "Addresses of recipients. In format `username@domain.com` or `Display Name `.", "title": "MessageTo" }, "cc": { "type": "array", "items": { "type": "string" }, "description": "Addresses of CC recipients. In format `username@domain.com` or `Display Name `.", "title": "MessageCc" }, "bcc": { "type": "array", "items": { "type": "string" }, "description": "Addresses of BCC recipients. In format `username@domain.com` or `Display Name `.", "title": "MessageBcc" }, "subject": { "type": "string", "description": "Subject of message.", "title": "MessageSubject" }, "preview": { "type": "string", "description": "Text preview of message.", "title": "MessagePreview" }, "text": { "type": "string", "description": "Plain text body of message.", "title": "MessageText" }, "html": { "type": "string", "description": "HTML body of message.", "title": "MessageHtml" }, "extracted_text": { "type": "string", "description": "Extracted new text content." }, "extracted_html": { "type": "string", "description": "Extracted new HTML content." }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "attachment_id": { "type": "string", "description": "ID of attachment.", "title": "AttachmentId" }, "filename": { "type": "string", "description": "Filename of attachment.", "title": "AttachmentFilename" }, "size": { "type": "integer", "description": "Size of attachment in bytes.", "title": "AttachmentSize" }, "content_type": { "type": "string", "description": "Content type of attachment.", "title": "AttachmentContentType" }, "content_disposition": { "type": "string", "enum": [ "inline", "attachment" ], "description": "Content disposition of attachment.", "title": "AttachmentContentDisposition" }, "content_id": { "type": "string", "description": "Content ID of attachment.", "title": "AttachmentContentId" } }, "required": [ "attachment_id", "size" ], "title": "Attachment" }, "description": "Attachments in message.", "title": "MessageAttachments" }, "in_reply_to": { "type": "string", "description": "ID of message being replied to.", "title": "MessageInReplyTo" }, "references": { "type": "array", "items": { "type": "string" }, "description": "IDs of previous messages in thread.", "title": "MessageReferences" }, "headers": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Headers in message.", "title": "MessageHeaders" }, "size": { "type": "integer", "description": "Size of message in bytes.", "title": "MessageSize" }, "updated_at": { "type": "string", "format": "date-time", "description": "Time at which message was last updated.", "title": "MessageUpdatedAt" }, "created_at": { "type": "string", "format": "date-time", "description": "Time at which message was created.", "title": "MessageCreatedAt" } }, "required": [ "inbox_id", "thread_id", "message_id", "labels", "timestamp", "from", "to", "size", "updated_at", "created_at" ], "title": "Message" }, "description": "Found messages. Order matches `message_ids` in the request. Body\nfields (`text`, `html`, `extracted_text`, `extracted_html`) are\nnever populated; use the single-message endpoint to retrieve bodies." } }, "required": [ "limit", "count", "messages" ], "title": "BatchGetMessagesResponse" } } } }, "400": { "description": "Error response with status 400", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of error.", "title": "ErrorName" }, "code": { "type": "string", "description": "Stable, machine-readable error code in snake_case (for example, not_found or missing_permission). Branch on this rather than the message text.", "title": "ErrorCode" }, "message": { "type": "string", "description": "Error message.", "title": "ErrorMessage" }, "errors": { "description": "Validation errors. Each entry has a path and a message identifying the invalid field." }, "fix": { "type": "string", "description": "The concrete next action that resolves the error.", "title": "ErrorFix" }, "docs": { "type": "string", "description": "Link to the error reference entry for this code.", "title": "ErrorDocs" } }, "required": [ "name", "errors" ], "title": "ValidationErrorResponse" } } } } } } ```