Modoboa Address Books API

The address-books API from Modoboa — 3 operation(s) for address-books.

Operations 3

GET /api/v2/address-books/default/ Address books default retrieve #
GET /api/v2/address-books/sync_from_cdav/ Address books sync from cdav retrieve #
GET /api/v2/address-books/sync_to_cdav/ Address books sync to cdav 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-address-books-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-address-books-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Modoboa Address Books 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: address-books
paths:
  /api/v2/address-books/default/:
    get:
      operationId: address_books_default_retrieve
      description: Return default user address book.
      tags:
      - address-books
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddressBook'
          description: ''
      summary: Address books default retrieve
      x-summary-source: derived
  /api/v2/address-books/sync_from_cdav/:
    get:
      operationId: address_books_sync_from_cdav_retrieve
      description: Synchronize from CardDAV address book.
      tags:
      - address-books
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddressBook'
          description: ''
      summary: Address books sync from cdav retrieve
      x-summary-source: derived
  /api/v2/address-books/sync_to_cdav/:
    get:
      operationId: address_books_sync_to_cdav_retrieve
      description: Synchronize address book with CardDAV collection.
      tags:
      - address-books
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddressBook'
          description: ''
      summary: Address books sync to cdav retrieve
      x-summary-source: derived
components:
  schemas:
    AddressBook:
      type: object
      description: Address book serializer.
      properties:
        pk:
          type: integer
          readOnly: true
          title: ID
        name:
          type: string
          maxLength: 50
        url:
          type: string
          readOnly: true
        last_sync:
          type:
          - string
          - 'null'
          format: date-time
        syncing:
          type: boolean
      required:
      - name
      - pk
      - url
  securitySchemes:
    oauth2:
      type: oauth2
      flows: {}
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"