Forward Email

Forward Email Domains API

> [!TIP] > Domain endpoints with a domain's name /v1/domains/:domain\_name as their endpoint are interchangeable with a domain's ID :domain\_id. This means you can refer to the domain by either its name or id value.

GitHub OpenAPI

Operations 13

GET /v1/domains List domains #
POST /v1/domains Create domain #
GET /v1/domains/{domain_id} Retrieve domain #
PUT /v1/domains/{domain_id} Update domain #
DELETE /v1/domains/{domain_id} Delete domain #
GET /v1/domains/{domain_id}/verify-records Verify domain records #
GET /v1/domains/{domain_id}/verify-smtp Verify domain SMTP records #
POST /v1/domains/{domain_id}/test-s3-connection Test custom S3 connection #
POST /v1/domains/{domain_id}/catch-all-passwords Create domain-wide catch-all password #
GET /v1/domains/{domain_id}/catch-all-passwords List domain-wide catch-all passwords #
DELETE /v1/domains/{domain_id}/catch-all-passwords/{token_id} Remove domain-wide catch-all password #
PUT /v1/domains/{domain_id}/allowlist Update domain allowlist #
PUT /v1/domains/{domain_id}/denylist Update domain denylist #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/forward-email/openapi/forward-email-domains-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/forward-email/json-schema/forward-email-domain-schema.json
📊
JSONSchema
https://artifacts.apis.io/forward-email/json-schema/forward-email-update-domain-input-schema.json
📊
JSONSchema
https://artifacts.apis.io/forward-email/json-schema/forward-email-message-schema.json
📊
JSONSchema
https://artifacts.apis.io/forward-email/json-schema/forward-email-smtp-schema.json
📊
JSONSchema
https://artifacts.apis.io/forward-email/json-schema/forward-email-alias-account-schema.json
📊
JSONSchema
https://artifacts.apis.io/forward-email/json-schema/forward-email-alias-input-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/forward-email:forward-email-domains-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

forward-email-domains-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Forward Email Domains API
  description: 'Welcome to the comprehensive API documentation for Forward Email. This API allows you to manage email forwarding, domains, aliases, outbound emails, and more programmatically.


    ## Key Features

    * **Domain Management:** Create, retrieve, update, delete, and verify domains.

    * **Alias Management:** Manage email aliases, including creation, updates, and recipient management.

    * **Outbound SMTP:** Send emails via SMTP, manage limits, and track sent emails.

    * **Account & Logs:** Manage your account details and download activity logs.

    * **Security:** Encrypt TXT records and manage domain members/invites.

    * **CardDAV Contacts:** Full CRUD operations for contact management with vCard support.

    * **CalDAV Calendars:** Complete calendar management with timezone and color support.

    * **IMAP/POP3 Messages:** Comprehensive message management with advanced search capabilities.

    * **IMAP/POP3 Folders:** Full folder management including creation, renaming, and deletion.


    ## Authentication

    Most endpoints require authentication using your **API Key**. Provide the API Key as the `username` in the Basic Authentication header, leaving the password empty.


    ```http

    Authorization: Basic QVBJX1RPS0VOOg==

    ```

    (Replace `API_TOKEN` with your actual key before Base64 encoding)


    Endpoints related to **Alias Contacts, Calendars, Messages, and Folders** require a generated alias username and password for Basic Authentication.


    ## Errors

    The API uses standard HTTP status codes to indicate success or failure. Error responses include a JSON body with a `message` field detailing the error.


    | Status Code | Meaning |

    |-------------|---------------------|

    | 200 | OK |

    | 400 | Bad Request |

    | 401 | Unauthorized |

    | 403 | Forbidden |

    | 404 | Not Found |

    | 409 | Conflict |

    | 412 | Precondition Failed |

    | 429 | Too Many Requests |

    | 500 | Internal Server Error|

    | 501 | Not Implemented |

    | 502 | Bad Gateway |

    | 503 | Service Unavailable |

    | 504 | Gateway Time-out |


    *If you encounter a `5xx` error, please contact api@forwardemail.net.*


    ## Localization

    API responses are translated based on the user''s detected locale or the `Accept-Language` header. Over 25 languages are supported.


    ## Pagination

    Endpoints returning lists support pagination via query parameters.


    | Parameter | Type | Optional | Description | Default | Constraints |

    |--------------|---------|----------|-----------------------------------------------------------------------------|---------|--------------------|

    | `page` | Integer | Yes | Page number to retrieve. | 1 | `>= 1` |

    | `limit` | Integer | Yes | Number of results per page. | 25 | `>= 1`, `<= 100` |

    | `pagination` | Boolean | Yes | Opt-in to pagination behavior (required before Nov 1st, 2024 for some endpoints). | false | |


    **Pagination Headers:**

    * `X-Page-Count`: Total page count.

    * `X-Page-Current`: Current page number.

    * `X-Page-Size`: Number of items on the current page.

    * `X-Item-Count`: Total number of items across all pages.

    * `Link`: Navigation links (prev, next, first, last).


    **Example:**

    ```bash

    curl "https://api.forwardemail.net/v1/domains?page=2&limit=20&pagination=true" \

    -u API_TOKEN:

    ```


    ## Recommended Libraries

    * **Ruby:** Faraday

    * **Python:** requests

    * **Java:** OkHttp

    * **PHP:** Guzzle

    * **JavaScript/Node.js:** superagent (Maintained by Forward Email)

    * **Go:** `net/http`

    * **.NET:** RestSharp'
  version: 1.0.0
  contact:
    name: Forward Email Support
    url: https://forwardemail.net
    email: api@forwardemail.net
servers:
- url: https://api.forwardemail.net
  description: Forward Email API Server
tags:


# --- truncated at 32 KB (38 KB total) ---
# Full source: https://artifacts.apis.io/forward-email/openapi/forward-email-domains-api-openapi.yml