> ## Documentation Index
> Fetch the complete documentation index at: https://sendmux.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List mailboxes

> Returns a cursor-paginated list of mailboxes configured for the team, ordered by `created_at` descending. Pass `cursor=<next_cursor>` from the previous response to fetch the next page.



## OpenAPI

````yaml /openapi-app.json get /mailboxes
openapi: 3.1.0
info:
  description: Programmatic access to your Sendmux email infrastructure.
  title: Sendmux API
  version: 1.0.0
servers:
  - description: API v1
    url: https://app.sendmux.ai/api/v1
security:
  - bearerAuth: []
paths:
  /mailboxes:
    get:
      tags:
        - Mailboxes
      summary: List mailboxes
      description: >-
        Returns a cursor-paginated list of mailboxes configured for the team,
        ordered by `created_at` descending. Pass `cursor=<next_cursor>` from the
        previous response to fetch the next page.
      operationId: managementListMailboxes
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Pagination cursor — the `next_cursor` from the previous response.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Max results (default 50, max 100)
            maximum: 100
            minimum: 1
            type: integer
        - in: query
          name: include_deleted
          required: false
          schema:
            description: >-
              Set to `true` to include deleted mailboxes in the response.
              Default `false`. Deleted mailboxes are retained for audit and
              delivery history.
            enum:
              - 'true'
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MailboxItemCursorListResponse'
          description: Mailbox list
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Authentication required
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Insufficient permissions
      security:
        - bearerAuth: []
components:
  schemas:
    MailboxItemCursorListResponse:
      allOf:
        - $ref: '#/components/schemas/SuccessEnvelope'
        - properties:
            data:
              items:
                $ref: '#/components/schemas/Mailbox'
              type: array
            meta:
              $ref: '#/components/schemas/ResponseMeta'
            pagination:
              $ref: '#/components/schemas/CursorPagination'
          required:
            - data
            - pagination
          type: object
      unevaluatedProperties: false
    ApiError:
      additionalProperties: false
      properties:
        error:
          additionalProperties: false
          properties:
            code:
              description: Machine-readable error code
              enum:
                - invalid_parameter
                - missing_parameter
                - authentication_required
                - insufficient_permissions
                - not_found
                - conflict
                - limit_exceeded
                - idempotency_conflict
                - payload_too_large
                - validation_error
                - rate_limit_exceeded
                - service_unavailable
                - internal_error
              example: invalid_parameter
              type: string
            doc_url:
              description: Link to relevant documentation
              type: string
            errors:
              description: >-
                Accumulated per-field issues for validation errors. Only present
                on 400/422 responses.
              items:
                $ref: '#/components/schemas/ApiErrorDetail'
              type: array
            message:
              description: Human-readable error description
              type: string
            param:
              description: The parameter that caused the error
              type: string
            retryable:
              description: >-
                Whether the caller may safely retry this request. 4xx are
                typically false (except 429); 5xx are typically true.
              example: false
              type: boolean
          required:
            - code
            - message
            - retryable
          type: object
        meta:
          additionalProperties: false
          properties:
            request_id:
              example: req_clxxxxxxxxxxxxxxxxxxxxxxxxx
              type: string
          required:
            - request_id
          type: object
        ok:
          enum:
            - false
          type: boolean
      required:
        - ok
        - error
        - meta
      type: object
    SuccessEnvelope:
      properties:
        meta:
          additionalProperties: {}
          properties: {}
          type: object
        ok:
          enum:
            - true
          type: boolean
      required:
        - ok
        - meta
      type: object
    Mailbox:
      additionalProperties: false
      properties:
        created_at:
          description: ISO 8601 creation timestamp
          type: string
        display_name:
          description: Optional display name shown in outbound From headers
          type:
            - string
            - 'null'
        email:
          description: Mailbox email address (lowercase)
          example: agent@acme.com
          type: string
        id:
          description: Public ID
          example: mbx_clxxxxxxxxxxxxxxxxxxxxxxxxx
          type: string
        quota_bytes:
          description: >-
            Storage quota in bytes. Current writable tiers are 1 GB, 5 GB, and
            50 GB.
          type:
            - integer
            - 'null'
        send_scope:
          $ref: '#/components/schemas/MailboxSendScope'
        status:
          description: active | suspended | deleted
          example: active
          type: string
      required:
        - id
        - email
        - display_name
        - quota_bytes
        - send_scope
        - status
        - created_at
      type: object
    ResponseMeta:
      additionalProperties: false
      properties:
        request_id:
          example: req_clxxxxxxxxxxxxxxxxxxxxxxxxx
          type: string
      required:
        - request_id
      type: object
    CursorPagination:
      additionalProperties: false
      properties:
        has_more:
          type: boolean
        next_cursor:
          type: string
      required:
        - has_more
      type: object
    ApiErrorDetail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Machine-readable issue code from the validator (e.g. zod issue
            code).
          example: invalid_string
          type: string
        field:
          description: Dot-path of the offending request field.
          example: recipient.email
          type: string
        message:
          description: Human-readable issue description.
          type: string
      required:
        - field
        - code
        - message
      type: object
    MailboxSendScope:
      additionalProperties: false
      properties:
        group_public_ids:
          description: Delivery group public IDs (only when type=group)
          items:
            type: string
          type: array
        provider_public_ids:
          description: Provider public IDs (only when type=providers)
          items:
            type: string
          type: array
        type:
          description: >-
            Outbound routing strategy. `all` lets the mailbox use any
            team-configured provider; `providers` restricts to the listed
            provider IDs; `group` routes via a delivery group.
          enum:
            - all
            - providers
            - group
          type: string
      required:
        - type
      type:
        - object
        - 'null'
  securitySchemes:
    bearerAuth:
      bearerFormat: API Key
      description: >-
        Sendmux API key. Use a root API key for Management API routes, or a
        mailbox credential for Mailbox API routes. Obtain keys from the
        dashboard under API Keys.
      scheme: bearer
      type: http

````