Modoboa Mailboxes API

The mailboxes API from Modoboa — 2 operation(s) for mailboxes.

Operations 2

GET /api/v2/mailboxes/ Mailboxes list #
GET /api/v2/mailboxes/{id}/ Mailboxes retrieve #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/modoboa:modoboa-mailboxes-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

modoboa-mailboxes-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Modoboa Mailboxes API
  version: v2
servers:
- url: https://demo.modoboa.org/api/schema-v2/
  description: Remote Demo server
- url: https://localhost:5000/api/schema-v2/
  description: Local server
tags:
- name: mailboxes
paths:
  /api/v2/mailboxes/:
    get:
      operationId: mailboxes_list
      description: RO mailbox viewset.
      tags:
      - mailboxes
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Mailbox'
          description: ''
      summary: Mailboxes list
      x-summary-source: derived
  /api/v2/mailboxes/{id}/:
    get:
      operationId: mailboxes_retrieve
      description: RO mailbox viewset.
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - mailboxes
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Mailbox'
          description: ''
      summary: Mailboxes retrieve
      x-summary-source: derived
components:
  schemas:
    Mailbox:
      type: object
      description: Base mailbox serializer.
      properties:
        pk:
          type: integer
          readOnly: true
          title: ID
        full_address:
          type: string
          format: email
        use_domain_quota:
          type: boolean
        quota:
          type: string
        message_limit:
          type:
          - integer
          - 'null'
          maximum: 9223372036854775807
          minimum: 0
          format: int64
          title: Message sending limit
          description: Number of messages this mailbox can send per day
        quota_usage:
          type: integer
          readOnly: true
        is_send_only:
          type: boolean
        sent_messages_in_percent:
          type:
          - integer
          - 'null'
          description: Return number of sent messages as a percentage.
          readOnly: true
      required:
      - full_address
      - pk
      - quota_usage
      - sent_messages_in_percent
  securitySchemes:
    oauth2:
      type: oauth2
      flows: {}
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"