Modoboa

Modoboa Contacts API

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

GitHub OpenAPI

Operations 6

GET /api/v2/contacts/ Contacts list #
POST /api/v2/contacts/ Contacts create #
GET /api/v2/contacts/{id}/ Contacts retrieve #
PUT /api/v2/contacts/{id}/ Contacts update #
PATCH /api/v2/contacts/{id}/ Contacts partial update #
DELETE /api/v2/contacts/{id}/ Contacts destroy #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/modoboa/openapi/modoboa-contacts-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/modoboa/json-schema/modoboa-domain-schema.json
📊
JSONSchema
https://artifacts.apis.io/modoboa/json-schema/modoboa-patched-domain-schema.json
📊
JSONSchema
https://artifacts.apis.io/modoboa/json-schema/modoboa-account-me-schema.json
📊
JSONSchema
https://artifacts.apis.io/modoboa/json-schema/modoboa-account-schema.json
📊
JSONSchema
https://artifacts.apis.io/modoboa/json-schema/modoboa-writable-account-schema.json
📊
JSONSchema
https://artifacts.apis.io/modoboa/json-schema/modoboa-patched-writable-account-schema.json

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-contacts-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.

GitHub Google LinkedIn

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

OpenAPI Specification

modoboa-contacts-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Modoboa Contacts 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: Contacts
paths:
  /api/v2/contacts/:
    get:
      operationId: contacts_list
      description: Contact ViewSet.
      parameters:
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - Contacts
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedContactList'
          description: ''
      summary: Contacts list
      x-summary-source: derived
    post:
      operationId: contacts_create
      description: Contact ViewSet.
      tags:
      - Contacts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Contact'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Contact'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Contact'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Contact'
          description: ''
      summary: Contacts create
      x-summary-source: derived
  /api/v2/contacts/{id}/:
    get:
      operationId: contacts_retrieve
      description: Contact ViewSet.
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - Contacts
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Contact'
          description: ''
      summary: Contacts retrieve
      x-summary-source: derived
    put:
      operationId: contacts_update
      description: Contact ViewSet.
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - Contacts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Contact'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Contact'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Contact'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Contact'
          description: ''
      summary: Contacts update
      x-summary-source: derived
    patch:
      operationId: contacts_partial_update
      description: Contact ViewSet.
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - Contacts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedContact'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedContact'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedContact'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Contact'
          description: ''
      summary: Contacts partial update
      x-summary-source: derived
    delete:
      operationId: contacts_destroy
      description: Contact ViewSet.
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - Contacts
      security:
      - tokenAuth: []
      responses:
        '204':
          description: No response body
      summary: Contacts destroy
      x-summary-source: derived
components:
  schemas:
    EmailAddress:
      type: object
      description: Email address serializer.
      properties:
        pk:
          type: integer
          readOnly: true
          title: ID
        address:
          type: string
          format: email
          maxLength: 254
        type:
          $ref: '#/components/schemas/TypeE1dEnum'
      required:
      - address
      - pk
      - type
    TypeE1dEnum:
      enum:
      - home
      - work
      - other
      type: string
      description: '* `home` - Home

        * `work` - Work

        * `other` - Other'
    PaginatedContactList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/Contact'
    Contact:
      type: object
      description: Contact serializer.
      properties:
        pk:
          type: integer
          readOnly: true
          title: ID
        first_name:
          type: string
          maxLength: 30
        last_name:
          type: string
          maxLength: 30
        categories:
          type: array
          items:
            type: integer
        emails:
          type: array
          items:
            $ref: '#/components/schemas/EmailAddress'
        phone_numbers:
          type: array
          items:
            $ref: '#/components/schemas/PhoneNumber'
        company:
          type: string
          maxLength: 100
        position:
          type: string
          maxLength: 200
        address:
          type: string
        zipcode:
          type: string
          maxLength: 15
        city:
          type: string
          maxLength: 100
        country:
          type: string
          maxLength: 100
        state:
          type: string
          maxLength: 100
        note:
          type: string
        birth_date:
          type:
          - string
          - 'null'
          format: date
        display_name:
          type: string
          maxLength: 60
      required:
      - emails
      - pk
    PatchedContact:
      type: object
      description: Contact serializer.
      properties:
        pk:
          type: integer
          readOnly: true
          title: ID
        first_name:
          type: string
          maxLength: 30
        last_name:
          type: string
          maxLength: 30
        categories:
          type: array
          items:
            type: integer
        emails:
          type: array
          items:
            $ref: '#/components/schemas/EmailAddress'
        phone_numbers:
          type: array
          items:
            $ref: '#/components/schemas/PhoneNumber'
        company:
          type: string
          maxLength: 100
        position:
          type: string
          maxLength: 200
        address:
          type: string
        zipcode:
          type: string
          maxLength: 15
        city:
          type: string
          maxLength: 100
        country:
          type: string
          maxLength: 100
        state:
          type: string
          maxLength: 100
        note:
          type: string
        birth_date:
          type:
          - string
          - 'null'
          format: date
        display_name:
          type: string
          maxLength: 60
    PhoneNumber:
      type: object
      description: Phone number serializer.
      properties:
        pk:
          type: integer
          readOnly: true
          title: ID
        number:
          type: string
          maxLength: 40
        type:
          $ref: '#/components/schemas/PhoneNumberTypeEnum'
      required:
      - number
      - pk
      - type
    PhoneNumberTypeEnum:
      enum:
      - home
      - work
      - other
      - main
      - cell
      - fax
      - pager
      type: string
      description: '* `home` - Home

        * `work` - Work

        * `other` - Other

        * `main` - Main

        * `cell` - Cellular

        * `fax` - Fax

        * `pager` - Pager'
  securitySchemes:
    oauth2:
      type: oauth2
      flows: {}
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"