https://palmyra.dev/docs/api/backend/ Recent content in Backend on Palmyra Hugo en-us https://palmyra.dev/docs/api/backend/overview/ Mon, 01 Jan 0001 00:00:00 +0000 https://palmyra.dev/docs/api/backend/overview/ <h1 id="reference-overview">Reference Overview<a class="anchor" href="#reference-overview">#</a></h1> <p>Palmyra&rsquo;s public surface has four groups.</p> <h2 id="annotations">Annotations<a class="anchor" href="#annotations">#</a></h2> <p>Schema mapping, routing, and permissions — see the <a href="https://palmyra.dev/docs/api/backend/annotations/">Annotations</a> section.</p> <ul> <li><strong>Type mapping</strong> — <code>@PalmyraType</code>, <code>@PalmyraMappingConfig</code>, <code>@PalmyraUniqueKey</code>, <code>@PalmyraForeignKey</code></li> <li><strong>Field mapping</strong> — <code>@PalmyraField</code>, <code>@PalmyraIgnore</code>, <code>@FetchConfig</code></li> <li><strong>Routing</strong> — <code>@CrudMapping</code>, <code>@ActionMapping</code></li> <li><strong>Security</strong> — <code>@Permission</code></li> </ul> <h2 id="handler-interfaces">Handler Interfaces<a class="anchor" href="#handler-interfaces">#</a></h2> <p><strong>Read-side</strong></p> <ul> <li><a href="https://palmyra.dev/docs/api/backend/handlers/query-handler/">QueryHandler</a> — paged, filtered reads</li> <li><a href="https://palmyra.dev/docs/api/backend/handlers/read-handler/">ReadHandler</a> — criteria-based reads</li> <li><a href="https://palmyra.dev/docs/api/backend/handlers/nativequery-handler/">NativeQueryHandler</a> — hand-written SQL</li> <li><a href="https://palmyra.dev/docs/api/backend/handlers/typedquery-handler/">TypedQueryHandler</a> — type-safe row callback</li> </ul> <p><strong>Write-side</strong></p> <ul> <li><a href="https://palmyra.dev/docs/api/backend/handlers/create-handler/">CreateHandler</a></li> <li><a href="https://palmyra.dev/docs/api/backend/handlers/update-handler/">UpdateHandler</a></li> <li><a href="https://palmyra.dev/docs/api/backend/handlers/save-handler/">SaveHandler</a> — upsert</li> <li><a href="https://palmyra.dev/docs/api/backend/handlers/delete-handler/">DeleteHandler</a></li> </ul> <p><strong>Export</strong></p> <ul> <li><a href="https://palmyra.dev/docs/api/backend/handlers/csv-handler/">CsvHandler</a></li> <li><a href="https://palmyra.dev/docs/api/backend/handlers/excel-handler/">ExcelHandler</a></li> <li><a href="https://palmyra.dev/docs/api/backend/handlers/customformat-handler/">CustomFormatHandler</a></li> </ul> <p><strong>Composite</strong></p> https://palmyra.dev/docs/api/backend/api-format/ Mon, 01 Jan 0001 00:00:00 +0000 https://palmyra.dev/docs/api/backend/api-format/ <h1 id="api-request--response-format">API Request &amp; Response Format<a class="anchor" href="#api-request--response-format">#</a></h1> <p>The complete HTTP contract for every Palmyra handler. Use this page if you&rsquo;re building your own frontend (mobile, desktop, CLI, third-party integration) and need to know exactly what to send and what comes back — without reading the handler reference pages.</p> <p>Every Palmyra endpoint speaks <strong>JSON</strong>. The request body (when present) is <code>Content-Type: application/json</code>. The response is always <code>application/json</code>.</p> <p>Throughout this page, the examples assume the following model and handler:</p>