Modoboa · Schema

PaginatedContactList

EmailMail ServerOpen SourceWebmailManagementCompany

Properties

Name Type Description
count integer
next stringnull
previous stringnull
results array
View JSON Schema on GitHub

JSON Schema

modoboa-paginated-contact-list-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/modoboa/json-schema/modoboa-paginated-contact-list-schema.json",
  "title": "PaginatedContactList",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/modoboa-contacts-api-openapi.yml#/components/schemas/PaginatedContactList",
  "type": "object",
  "required": [
    "count",
    "results"
  ],
  "properties": {
    "count": {
      "type": "integer"
    },
    "next": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri"
    },
    "previous": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri"
    },
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Contact"
      }
    }
  },
  "$defs": {
    "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": "#/$defs/EmailAddress"
          }
        },
        "phone_numbers": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/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"
      ]
    },
    "EmailAddress": {
      "type": "object",
      "description": "Email address serializer.",
      "properties": {
        "pk": {
          "type": "integer",
          "readOnly": true,
          "title": "ID"
        },
        "address": {
          "type": "string",
          "format": "email",
          "maxLength": 254
        },
        "type": {
          "$ref": "#/$defs/TypeE1dEnum"
        }
      },
      "required": [
        "address",
        "pk",
        "type"
      ]
    },
    "PhoneNumber": {
      "type": "object",
      "description": "Phone number serializer.",
      "properties": {
        "pk": {
          "type": "integer",
          "readOnly": true,
          "title": "ID"
        },
        "number": {
          "type": "string",
          "maxLength": 40
        },
        "type": {
          "$ref": "#/$defs/PhoneNumberTypeEnum"
        }
      },
      "required": [
        "number",
        "pk",
        "type"
      ]
    },
    "PhoneNumberTypeEnum": {
      "enum": [
        "home",
        "work",
        "other",
        "main",
        "cell",
        "fax",
        "pager"
      ],
      "type": "string",
      "description": "* `home` - Home\n* `work` - Work\n* `other` - Other\n* `main` - Main\n* `cell` - Cellular\n* `fax` - Fax\n* `pager` - Pager"
    },
    "TypeE1dEnum": {
      "enum": [
        "home",
        "work",
        "other"
      ],
      "type": "string",
      "description": "* `home` - Home\n* `work` - Work\n* `other` - Other"
    }
  }
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • 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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/modoboa-paginated-contact-list"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.