> ## 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 inboxes



## OpenAPI

````yaml /openapi.json get /inboxes
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: []
paths:
  /inboxes:
    get:
      operationId: inbox.list
      parameters:
        - name: cursor
          in: query
          schema:
            type: string
            pattern: ^[cC][^\s-]{8,}$
            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: query
          in: query
          schema:
            type: string
            description: Free-text search query to filter inboxes by email or display name
          allowEmptyValue: true
          allowReserved: true
        - name: agentId
          in: query
          schema:
            type: string
            pattern: ^[cC][^\s-]{8,}$
            description: >-
              Filter to the inboxes belonging to one agent. Omit for every inbox
              in the org, including unassigned ones — an inbox's agent is
              nullable, and deleting an agent leaves its inboxes behind rather
              than removing them.
          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: ^[cC][^\s-]{8,}$
                          description: Unique identifier of the inbox
                        email:
                          type: string
                          format: email
                          description: Full email address of the inbox
                        domain:
                          type: string
                          description: Domain portion of the inbox email address
                        localPart:
                          type: string
                          description: Local part (before the @) of the inbox email address
                        displayName:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Human-readable display name, or null if not set
                        agentId:
                          type: string
                          pattern: ^[cC][^\s-]{8,}$
                          description: ID of the agent this inbox belongs to
                        createdAt:
                          type: string
                          format: date-time
                          description: Timestamp when the inbox was created
                        agentName:
                          type: string
                          description: Name of the agent that owns this inbox
                        unreadCount:
                          type: integer
                          minimum: 0
                          description: >-
                            Unread messages in this inbox — inbound mail
                            carrying the `unread` label, excluding spam,
                            archived and trashed. The number a mailbox list has
                            to show to be worth reading at all.
                        lastMessageAt:
                          anyOf:
                            - type: string
                              format: date-time
                            - type: 'null'
                          description: >-
                            When this inbox last sent or received anything, or
                            null if it never has
                      required:
                        - id
                        - email
                        - domain
                        - localPart
                        - displayName
                        - agentId
                        - createdAt
                        - agentName
                        - unreadCount
                        - lastMessageAt
                      description: An inbox with its unread count, as returned in a list
                    description: Array of inbox resources matching the query
                  pagination:
                    type: object
                    properties:
                      nextCursor:
                        anyOf:
                          - type: string
                            pattern: ^[cC][^\s-]{8,}$
                          - 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 inboxes
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT Bearer token obtained from authentication. Pass as: Authorization:
        Bearer <token>
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'API key for programmatic access. Pass as: X-API-Key: <your-key>'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.