Kindly EditDocumentationTry the editor

REST endpoint catalog

All 46 registered route patterns, methods, permissions, argument schemas, and implementation links.

Base URL#

The plugin namespace is /wp-json/cantata-edit/v1. The list below is extracted from the running 0.9.13 route registry, including routes whose namespace is assembled dynamically in PHP.

Routes#

  • /screens: GET, POST; Read or update enabled site screen sizes and their boundaries.
  • /design-system: GET, POST; Read or update shared variables and reusable classes with revision checks.
  • /forms/{post}/{form}: POST; Submit a published form or read and save its private action settings.
  • /forms/{post}/{form}/settings: GET, POST; Submit a published form or read and save its private action settings.
  • /globals: GET, POST; List, create, read, update, or remove linked global sources.
  • /globals/{id}: GET, POST, DELETE; List, create, read, update, or remove linked global sources.
  • /popups: GET, POST; Manage popup records, their publication status, settings schema, or public event statistics.
  • /popups/{id}: DELETE; Manage popup records, their publication status, settings schema, or public event statistics.
  • /popups/{id}/duplicate: POST; Manage popup records, their publication status, settings schema, or public event statistics.
  • /popups/{id}/status: POST; Manage popup records, their publication status, settings schema, or public event statistics.
  • /popups/schema: GET; Manage popup records, their publication status, settings schema, or public event statistics.
  • /popups/{id}/event: POST; Manage popup records, their publication status, settings schema, or public event statistics.
  • /popups/{id}/stats: GET, DELETE; Manage popup records, their publication status, settings schema, or public event statistics.
  • /themes: GET, POST; Manage theme templates and their display-rule metadata.
  • /themes/{id}: GET, POST, DELETE; Manage theme templates and their display-rule metadata.
  • /own-layout/{id}: POST; Set whether a page uses its own layout instead of a matching theme template.
  • /loops: GET, POST; List, create, read, or remove reusable loop item templates.
  • /loops/{id}: GET, DELETE; List, create, read, or remove reusable loop item templates.
  • /element-php/check: POST; Validate, stage, or read authorized PHP resources and inspect provider information.
  • /element-php/stage: POST; Validate, stage, or read authorized PHP resources and inspect provider information.
  • /element-php/read: POST; Validate, stage, or read authorized PHP resources and inspect provider information.
  • /element-php/provider: GET; Validate, stage, or read authorized PHP resources and inspect provider information.
  • /live: POST; Render a registered live-content source with validated fields.
  • /media-categories: GET; Read available media categories for library filtering.
  • /templates: GET, POST; Manage saved layout copies in the template library.
  • /templates/{id}: GET, DELETE; Manage saved layout copies in the template library.
  • /design: GET; Read the resolved theme design choices available to the editor.
  • /theme-settings: GET, and POST to /validate, /draft, /publish and /discard; Read, check, save, publish, or discard the client design from Kindly Edit > Theme (0.9.15).
  • /save: POST; Save an atomic draft or publish content and related metadata after permission, validation, and conflict checks.
  • /sanitize: POST; Validate and clean candidate markup using the editor’s server rules.
  • /links: POST; Find page destinations for the link picker.
  • /trash: POST; Move an authorized page to the trash.
  • /mode: POST; Update the authorized editor-mode preference.
  • /preferences: POST; Save supported per-user editor preferences.
  • /discard: POST; Discard a saved editing draft using the current state checks.
  • /build: POST; Build an eligible page into the Kindly native editing model.
  • /pages: POST; Create a page through the editor’s authorized page workflow.
  • /address: GET; Read current page address information.
  • /history: GET; List recorded versions available for restoration.
  • /restore: POST; Restore an authorized historical version after conflict checks.
  • /keptdraft: POST; Recover or retain draft state through the editor’s recovery workflow.
  • /revs: GET; Read revision state for synchronization and conflict detection.
  • /components: GET; Read theme component choices.
  • /context-help: POST; Request context-aware editor guidance using bounded selection context.
  • /build-contract: GET; Read the native build contract and its validation guidance.
  • /element-code: GET, POST; Read or draft an explicit element code owner using code-specific permissions.
  • /intro-seen: POST; Record that the current user has seen the introduction.
About this page

Documents Kindly Edit 0.9.16. Source: WordPress REST registry, Kindly Edit 0.9.13. Theme choices and account permissions can change which controls appear.

Type a word or phrase to search the full documentation.