fatheron-dev

fatheron-dev Mail Sync API

The mail-sync API from fatheron-dev — 13 operation(s) for mail-sync.

GitHub OpenAPI

Operations 14

GET /v1/mail-sync/providers Get Providers #
GET /v1/mail-sync/cutover-checklist Get Cutover Checklist #
GET /v1/mail-sync/connections Get Connections #
DELETE /v1/mail-sync/connections/{connection_id} Delete Connection #
POST /v1/mail-sync/connections/imap Post Imap Connection #
POST /v1/mail-sync/oauth/start Post Oauth Start #
GET /v1/mail-sync/oauth/callback Get Oauth Callback #
GET /v1/mail-sync/jobs Get Jobs #
POST /v1/mail-sync/jobs Post Job #
GET /v1/mail-sync/jobs/{job_id} Get Job Detail #
POST /v1/mail-sync/jobs/{job_id}/pause Post Pause Job #
POST /v1/mail-sync/jobs/{job_id}/resume Post Resume Job #
POST /v1/mail-sync/jobs/{job_id}/cutover-delta Post Cutover Delta #
POST /v1/mail-sync/jobs/{job_id}/cancel Post Cancel Job #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/fatheron-dev/openapi/fatheron-dev-mail-sync-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/fatheron-dev/json-schema/fatheron-dev-update-mailbox-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/fatheron-dev/json-schema/fatheron-dev-merch-checkout-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/fatheron-dev/json-schema/fatheron-dev-register-acquire-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/fatheron-dev/json-schema/fatheron-dev-upsert-broker-brand-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/fatheron-dev/json-schema/fatheron-dev-purchase-gift-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/fatheron-dev/json-schema/fatheron-dev-put-pgp-private-key-backup-request-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/fatheron-dev:fatheron-dev-mail-sync-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

fatheron-dev-mail-sync-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Fat Heron Builders Mail Sync API
  description: 'Fat Heron for Developers (fatheron.dev) — automation endpoints for builders and agents. Authenticate with a builders JWT or account API key (`X-API-Key: fh_live_…`). Versioned under `/v1`; see fatheron.dev/docs for the capability index and versioning policy.'
  version: 0.3.0
security:
- bearerAuth: []
- apiKeyAuth: []
tags:
- name: mail-sync
paths:
  /v1/mail-sync/providers:
    get:
      tags:
      - mail-sync
      summary: Get Providers
      operationId: get_providers_v1_mail_sync_providers_get
      parameters:
      - name: Authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-API-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: fh_access_token
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Fh Access Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/mail-sync/cutover-checklist:
    get:
      tags:
      - mail-sync
      summary: Get Cutover Checklist
      operationId: get_cutover_checklist_v1_mail_sync_cutover_checklist_get
      parameters:
      - name: Authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-API-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: fh_access_token
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Fh Access Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/mail-sync/connections:
    get:
      tags:
      - mail-sync
      summary: Get Connections
      operationId: get_connections_v1_mail_sync_connections_get
      parameters:
      - name: Authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-API-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: fh_access_token
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Fh Access Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/mail-sync/connections/{connection_id}:
    delete:
      tags:
      - mail-sync
      summary: Delete Connection
      operationId: delete_connection_v1_mail_sync_connections__connection_id__delete
      parameters:
      - name: connection_id
        in: path
        required: true
        schema:
          type: string
          title: Connection Id
      - name: Authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-API-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: fh_access_token
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Fh Access Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/mail-sync/connections/imap:
    post:
      tags:
      - mail-sync
      summary: Post Imap Connection
      operationId: post_imap_connection_v1_mail_sync_connections_imap_post
      parameters:
      - name: Authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-API-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: fh_access_token
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Fh Access Token
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImapConnectBody'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/mail-sync/oauth/start:
    post:
      tags:
      - mail-sync
      summary: Post Oauth Start
      operationId: post_oauth_start_v1_mail_sync_oauth_start_post
      parameters:
      - name: Authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-API-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: fh_access_token
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Fh Access Token
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OAuthStartBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/mail-sync/oauth/callback:
    get:
      tags:
      - mail-sync
      summary: Get Oauth Callback
      description: Public browser redirect from Microsoft/Google — no session cookie required.
      operationId: get_oauth_callback_v1_mail_sync_oauth_callback_get
      parameters:
      - name: code
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Code
      - name: state
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: State
      - name: error
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
      - name: error_description
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Error Description
      - name: Authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-API-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: fh_access_token
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Fh Access Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/mail-sync/jobs:
    get:
      tags:
      - mail-sync
      summary: Get Jobs
      operationId: get_jobs_v1_mail_sync_jobs_get
      parameters:
      - name: mailbox_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Mailbox Id
      - name: Authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-API-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: fh_access_token
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Fh Access Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - mail-sync
      summary: Post Job
      operationId: post_job_v1_mail_sync_jobs_post
      parameters:
      - name: Authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-API-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: fh_access_token
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Fh Access Token
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartJobBody'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/mail-sync/jobs/{job_id}:
    get:
      tags:
      - mail-sync
      summary: Get Job Detail
      operationId: get_job_detail_v1_mail_sync_jobs__job_id__get
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      - name: Authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-API-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: fh_access_token
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Fh Access Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/mail-sync/jobs/{job_id}/pause:
    post:
      tags:
      - mail-sync
      summary: Post Pause Job
      operationId: post_pause_job_v1_mail_sync_jobs__job_id__pause_post
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      - name: Authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-API-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: fh_access_token
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Fh Access Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/mail-sync/jobs/{job_id}/resume:
    post:
      tags:
      - mail-sync
      summary: Post Resume Job
      operationId: post_resume_job_v1_mail_sync_jobs__job_id__resume_post
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      - name: Authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-API-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: fh_access_token
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Fh Access Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/mail-sync/jobs/{job_id}/cutover-delta:
    post:
      tags:
      - mail-sync
      summary: Post Cutover Delta
      operationId: post_cutover_delta_v1_mail_sync_jobs__job_id__cutover_delta_post
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      - name: Authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-API-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: fh_access_token
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Fh Access Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/mail-sync/jobs/{job_id}/cancel:
    post:
      tags:
      - mail-sync
      summary: Post Cancel Job
      operationId: post_cancel_job_v1_mail_sync_jobs__job_id__cancel_post
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      - name: Authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-API-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: fh_access_token
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Fh Access Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ImapConnectBody:
      properties:
        host:
          type: string
          maxLength: 255
          minLength: 1
          title: Host
        username:
          type: string
          maxLength: 320
          minLength: 1
          title: Username
        password:
          type: string
          maxLength: 512
          minLength: 1
          title: Password
        port:
          type: integer
          title: Port
          default: 993
        use_ssl:
          type: boolean
          title: Use Ssl
          default: true
        preset_id:
          anyOf:
          - type: string
            maxLength: 32
          - type: 'null'
          title: Preset Id
      type: object
      required:
      - host
      - username
      - password
      title: ImapConnectBody
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    StartJobBody:
      properties:
        mailbox_id:
          type: string
          maxLength: 64
          minLength: 1
          title: Mailbox Id
        connection_id:
          type: string
          maxLength: 64
          minLength: 1
          title: Connection Id
        mode:
          type: string
          title: Mode
          default: migrate
        include_archive:
          type: boolean
          title: Include Archive
          default: true
      type: object
      required:
      - mailbox_id
      - connection_id
      title: StartJobBody
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    OAuthStartBody:
      properties:
        provider:
          type: string
          title: Provider
          default: microsoft
        mailbox_id:
          anyOf:
          - type: string
            maxLength: 64
          - type: 'null'
          title: Mailbox Id
        return_to:
          anyOf:
          - type: string
            maxLength: 500
          - type: 'null'
          title: Return To
      type: object
      title: OAuthStartBody
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Keycloak access token.
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Account API key (fh_live_…).