Editor API

By Pierre-Philippe Charlier

The free write API that puts a pocket editor on your Statamic site: drafts, revisions, publishing and native permissions, built for the Editor for Drupal & Statamic iOS app.

Editor API Main Screenshot

Your content lives in Statamic. Your ideas don't wait for a laptop.

Editor API adds a clean, complete REST write API to your Statamic 6 site — designed for Editor for Drupal & Statamic, the iOS app, and open to any client you want to build. No hosted service, no sync, no middleman: your site is the only backend.

Free and open source (MIT). Install it on as many sites as you like — nothing to buy, no licence key. Source on GitHub: ppcharlier/statamic-editor-api.

What you get

  • Control Panel parity, the safe way. Everything goes through Statamic's public facades — the same path the CP uses. No private controllers, no fragile workarounds.
  • Drafts by default, publishing on purpose. PATCH saves a working copy; publishing is an explicit action with its own endpoint and message.
  • Revisions & working copies. Full history, semantic restore — when revisions are enabled on the collection.
  • Your permissions, untouched. Tokens are tied to real Statamic users and their native roles and permissions. Nothing to duplicate, nothing to drift.
  • Byte-faithful Bard. ProseMirror documents round-trip verbatim — unknown node types, custom attributes and whitespace included. What your editor sends is exactly what your site stores.
  • Conflict detection. X-Base-Modified guards every write — two editors can't silently overwrite each other.
  • The whole surface. Entries, assets (upload included), taxonomy terms, globals, navigations and form submissions — plus blueprints, so clients can render forms dynamically.
  • Multi-site ready. Localized entries, linked localizations, per-site globals and terms.

Works with and without Pro

No Pro? The API degrades gracefully: direct saves instead of working copies, single user. With Pro you get revisions, multiple users and multi-site. Clients can read /config to adapt their UI per collection.

Getting started

composer require ppcharlier/statamic-editor-api

Sign in from your client with a Statamic user's credentials (POST /api/editor/v1/auth/tokens) and you're ready. Tokens are revocable, rate-limited and stored server-side; a Sanctum driver is available if you prefer database tokens.

Also for Drupal

The same contract — same envelopes, same capabilities, same error codes — exists as a module for Drupal 11: ppcharlier/drupal-editor-api, free as well (GPL-2.0-or-later). One app, both CMS.

Requirements

  • Statamic 6
  • PHP 8.3+

Built as the backend of Editor for Drupal & Statamic, the iPhone and iPad app — write in Bard natively, offline drafts included, publish in one gesture.