Appearance

OpenAPI Spec ​

The full OpenAPI 3.0 specification is available for download and import into your favorite API client.

Interactive Documentation ​

Browse the interactive API reference powered by Scalar:

Open API Reference →

Download Spec ​

bash
curl -O https://api.mail.cx/api/docs/openapi.yaml

Or download directly: openapi.yaml

Import into API Clients ​

Postman ​

  1. Open Postman → Import → Link
  2. Paste: https://api.mail.cx/api/docs/openapi.yaml
  3. Click Import

Insomnia ​

  1. Open Insomnia → Import/Export → Import Data
  2. Choose From URL
  3. Paste: https://api.mail.cx/api/docs/openapi.yaml

Bruno ​

  1. Open Bruno → Collection → Import
  2. Select OpenAPI → paste the URL or downloaded file

Generate Client SDKs ​

Use OpenAPI Generator to auto-generate client libraries:

bash
# Install
npm install @openapitools/openapi-generator-cli -g

# Generate Python client
openapi-generator-cli generate \
  -i https://api.mail.cx/api/docs/openapi.yaml \
  -g python \
  -o ./mailcx-python

# Generate JavaScript/TypeScript client
openapi-generator-cli generate \
  -i https://api.mail.cx/api/docs/openapi.yaml \
  -g typescript-fetch \
  -o ./mailcx-ts

# Generate Go client
openapi-generator-cli generate \
  -i https://api.mail.cx/api/docs/openapi.yaml \
  -g go \
  -o ./mailcx-go

Mail.cx API Documentation