API reference

The Plugin API has three surfaces. They differ in who calls them and how they authenticate.

Most integrations only call the Backend surface. The Embedded surface is documented so you can read the editor's network traffic and understand quotas and errors; the editor calls it for you.

Base URL

https://api.maileditor.net/api

Paths on the following pages are relative to this base.

Response envelope

Every response, success or failure, has the same shape:

{
  "message": "Human readable message",
  "result": { }
}

result is null when there is no payload. Failures put a machine-readable code in result.error. Validation failures use errors keyed by field instead. All codes are collected in Error codes.

Headers

Embedded

The editor sets these on every request.

Backend

No CORS headers are sent, so browsers cannot call this surface.

Pagination

List endpoints accept per_page and page and return paginated data, links and meta objects:

{
  "data": [],
  "links": { "first": "…", "last": "…", "prev": null, "next": null },
  "meta": { "current_page": 1, "from": 1, "last_page": 1, "per_page": 15, "to": 1, "total": 1 }
}

Endpoint index

Embedded

Backend

Public