> ## Documentation Index > Fetch the complete documentation index at: https://docs.useanima.sh/llms.txt > Use this file to discover all available pages before exploring further. # Get messages 1 ## OpenAPI ````yaml /openapi.json get /messages openapi: 3.1.1 info: title: Anima API version: 0.1.0 description: >- The Anima API provides programmatic access to unified infrastructure for AI agents: create and manage agents; send and receive email; place phone calls and send/receive SMS and voice; store and retrieve vault credentials; manage agent identity; and configure webhooks for real-time events. Authenticate using a Bearer token or an API key passed via the X-API-Key header. contact: name: Anima Labs url: https://useanima.sh email: support@useanima.sh license: name: MIT url: https://opensource.org/licenses/MIT servers: - url: https://api.useanima.sh/v1 description: Production security: - BearerAuth: [] - ApiKeyAuth: [] tags: - name: Agents description: Create and manage AI agents with email and phone capabilities - name: Inboxes description: Manage email inboxes and their configurations - name: Messages description: Send, receive, and search email messages - name: Webhooks description: Register and manage webhook subscriptions for real-time events - name: Organizations description: Manage organizations and team settings - name: Domains description: Configure and verify custom email domains - name: Phone description: Manage phone numbers and SMS/voice capabilities - name: Invoices description: Track invoices, match receipts, and reconcile payments - name: Billing description: View usage, tiers, and billing information - name: Security description: Configure security policies and access controls - name: Vault description: Store and retrieve encrypted secrets - name: API Keys description: Create and manage API keys for programmatic access paths: /messages: get: operationId: message.list parameters: - name: cursor in: query schema: type: string pattern: ^[0-9A-HJKMNP-TV-Z]{26}$ description: Opaque cursor from a previous response to fetch the next page allowEmptyValue: true allowReserved: true - name: limit in: query schema: default: 20 type: integer minimum: 1 maximum: 100 description: Maximum number of items to return per page (1–100, default 20) allowEmptyValue: true allowReserved: true - name: agentId in: query schema: type: string pattern: ^[0-9A-HJKMNP-TV-Z]{26}$ description: Filter messages by agent ID allowEmptyValue: true allowReserved: true - name: threadId in: query schema: type: string pattern: ^[0-9A-HJKMNP-TV-Z]{26}$ description: Filter messages by conversation thread ID allowEmptyValue: true allowReserved: true - name: channel in: query schema: enum: - EMAIL - SMS - MMS - VOICE type: string description: Filter messages by communication channel allowEmptyValue: true allowReserved: true - name: direction in: query schema: enum: - INBOUND - OUTBOUND type: string description: Filter messages by direction (inbound or outbound) allowEmptyValue: true allowReserved: true - name: status in: query schema: enum: - QUEUED - SENT - DELIVERED - FAILED - BOUNCED - BLOCKED - PENDING_APPROVAL type: string description: Filter messages by delivery status allowEmptyValue: true allowReserved: true - name: dateRange in: query schema: type: object properties: from: type: string format: date-time description: Inclusive start of the date range in ISO 8601 format to: type: string format: date-time description: Inclusive end of the date range in ISO 8601 format description: Filter messages within a date range style: deepObject explode: true allowEmptyValue: true allowReserved: true responses: '200': description: OK content: application/json: schema: type: object properties: items: type: array items: type: object properties: id: type: string pattern: ^[0-9A-HJKMNP-TV-Z]{26}$ description: Unique identifier of the message agentId: type: string pattern: ^[0-9A-HJKMNP-TV-Z]{26}$ description: ID of the agent that sent or received the message channel: enum: - EMAIL - SMS - MMS - VOICE type: string description: Communication channel used direction: enum: - INBOUND - OUTBOUND type: string description: Whether the message was inbound or outbound status: enum: - QUEUED - SENT - DELIVERED - FAILED - BOUNCED - BLOCKED - PENDING_APPROVAL type: string description: Current delivery status fromAddress: type: string description: Sender address (email or phone number) toAddress: type: string description: Recipient address (email or phone number) subject: anyOf: - type: string - type: 'null' description: >- Message subject line, or null for channels that do not support subjects body: type: string description: Plain-text content of the message bodyHtml: anyOf: - type: string - type: 'null' description: >- HTML content of the message, or null if not available headers: anyOf: - type: object additionalProperties: {} - type: 'null' description: Raw message headers as key-value pairs, or null metadata: anyOf: - type: object additionalProperties: {} - type: 'null' description: Arbitrary metadata attached to the message, or null threadId: anyOf: - type: string - type: 'null' description: Thread identifier for conversation grouping, or null inReplyTo: anyOf: - type: string - type: 'null' description: Message ID this message is replying to, or null externalId: anyOf: - type: string - type: 'null' description: Provider-assigned external identifier, or null sentAt: anyOf: - type: string format: date-time - type: 'null' description: >- Timestamp when the message was sent, or null if not yet sent receivedAt: anyOf: - type: string format: date-time - type: 'null' description: >- Timestamp when the message was received, or null for outbound messages attachments: type: array items: type: object properties: id: type: string pattern: ^[0-9A-HJKMNP-TV-Z]{26}$ description: Unique identifier of the attachment filename: type: string description: Original filename of the attachment mimeType: type: string description: >- MIME type of the attachment (e.g. application/pdf) sizeBytes: type: integer minimum: 0 description: File size in bytes storageKey: type: string description: Internal storage key for retrieving the file url: anyOf: - type: string format: uri - type: 'null' description: >- Pre-signed download URL, or null if not yet generated createdAt: type: string format: date-time description: Timestamp when the attachment was created scanStatus: enum: - PENDING - CLEAN - FLAGGED - BLOCKED type: string description: >- Content-scan verdict. BLOCKED attachments cannot be downloaded — inspect before fetching bytes. detectedMimeType: anyOf: - type: string - type: 'null' description: >- MIME type inferred from magic bytes; may differ from the declared mimeType required: - id - filename - mimeType - sizeBytes - storageKey - url - createdAt - scanStatus - detectedMimeType description: File attachment associated with a message description: File attachments associated with this message createdAt: type: string format: date-time description: Timestamp when the message record was created updatedAt: type: string format: date-time description: Timestamp when the message record was last updated required: - id - agentId - channel - direction - status - fromAddress - toAddress - subject - body - bodyHtml - headers - metadata - threadId - inReplyTo - externalId - sentAt - receivedAt - attachments - createdAt - updatedAt description: Full message resource representation description: Array of message resources matching the query pagination: type: object properties: nextCursor: anyOf: - type: string pattern: ^[0-9A-HJKMNP-TV-Z]{26}$ - type: 'null' description: >- Cursor to pass as the `cursor` parameter to retrieve the next page, or null if no more results hasMore: type: boolean description: Whether additional pages of results are available required: - nextCursor - hasMore description: Pagination metadata for retrieving additional pages required: - items - pagination description: Paginated list of messages components: securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer ApiKeyAuth: type: apiKey in: header name: X-API-Key description: 'API key for programmatic access. Pass as: X-API-Key: ' ````