Postal

Postal API

Postal API as documented publicly: 3 operations. Contract generated from the documentation by API Evangelist (2026-10-27); not the provider's own document.

Documentation GitHub OpenAPI

Operations 3

GET / GET / #

GET /api/v1/messages/message GET Message #

GET /postalserver/install/opt/postal/install GET /postalserver/install/opt/postal/install #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/postal-server/openapi/_ae-authored/postal-server-openapi-generated.yml

Schemas & Data

📊

JSONSchema

https://artifacts.apis.io/postal-server/json-schema/postal-server-get-api-v1-messages-message-response-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/postal-server:postal-server-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

openapi: 3.1.0
info:
  title: Postal API
  version: '2026-10-27'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-27: 3 operation(s) read from 2 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Postal has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 2
    documentation: 1
    pages-with-code: 2
    pages-read: 2
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-27'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.postalserver.io/getting-started/prerequisites
  - https://docs.postalserver.io/developer/api
paths:
  /:
    get:
      operationId: get
      tags:
      - Api
      summary: GET /
      x-source: https://docs.postalserver.io/developer/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl Request You can use the following cURL command to make the request: curl --location ' https://<your.postal.domain.com>/api/v1/messages/message\
          \ '  --header ' X-Server-API-Key: $yourAPIKeyFromTheCredentialsPage '  --header ' Content-Type: application/json '  --data ' {\n \"\
          id\": 14,\n \"_expansions\": true\n } '\n Users & Permissions Global administrators, organization members and what each can do. Cli"
  /api/v1/messages/message:
    get:
      operationId: get_api_v1_messages_message
      tags:
      - Api
      summary: GET Message
      x-source: https://docs.postalserver.io/developer/api
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1MessagesMessageResponse'
      x-evidence:
        kind: documentation
  /postalserver/install/opt/postal/install:
    get:
      operationId: get_postalserver_install_opt_postal_install
      tags:
      - Postalserver
      summary: GET /postalserver/install/opt/postal/install
      x-source: https://docs.postalserver.io/getting-started/prerequisites
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl jq\n On CentOS/RHEL: yum install git curl jq\n Git & installation helper repository You'll need to make sure you have git\
          \ installed on your server. You'll then need to clone the Postal installation helper repository. This contains some bootstrapping config\
          \ and other useful things which will speed along your installation. git clone https://github.com/postalserver/install/opt/postal/install\n\
          sudo "
components:
  schemas:
    GetApiV1MessagesMessageResponse:
      type: object
      properties:
        id:
          type: integer
          description: Message identifier
        _expansions:
          type: boolean
          description: Flag indicating expanded data was requested
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-Server-API-Key
security:
- apiKey: []
tags:
- name: Api
- name: Postalserver