Reference

API reference

Every endpoint, and which need a session.

Every HTTP endpoint of the app, read from its route files. Session means the request needs a signed-in session (the deployment passcode, or the app's own sign-in); Public endpoints answer anyone.

Note

Requests that change data must come from the app's own pages; send JSON unless an endpoint says otherwise.

/api/edit-auth

Method Path Access What it does
GET /api/edit-auth Session —
POST /api/edit-auth Session —
DELETE /api/edit-auth Session —

/api/items

Method Path Access What it does
GET /api/items Session —
POST /api/items Session —
PATCH /api/items/:id Session —
DELETE /api/items/:id Session —
GET /api/items/:id/checklist Session —
POST /api/items/:id/checklist Session —
PATCH /api/items/:id/checklist/:checklistId Session —
DELETE /api/items/:id/checklist/:checklistId Session —
GET /api/items/:id/checklist/:checklistId/comments Session —
POST /api/items/:id/checklist/:checklistId/comments Session —
DELETE /api/items/:id/checklist/:checklistId/comments/:commentId Session —
GET /api/items/:id/checklist/:checklistId/documents Session —
POST /api/items/:id/checklist/:checklistId/documents Session —
DELETE /api/items/:id/checklist/:checklistId/documents/:documentId Session —
GET /api/items/:id/checklist/:checklistId/documents/:documentId/file Session —
GET /api/items/:id/checklist/:checklistId/subtasks Session —
POST /api/items/:id/checklist/:checklistId/subtasks Session —
PATCH /api/items/:id/checklist/:checklistId/subtasks/:subtaskId Session —
DELETE /api/items/:id/checklist/:checklistId/subtasks/:subtaskId Session —
GET /api/items/:id/documents Session —
POST /api/items/:id/documents Session —
DELETE /api/items/:id/documents/:docId Session —
GET /api/items/:id/documents/:docId/file Session —

Other routes

Method Path Access What it does
GET /health Public Liveness and database check. The System Registry lists https://<host>/health for every catalog.

Pages in the app

Page What it shows
/ —
/edit —
/item/:slug —
/item/:slug/workspace —
Last updated 2 November 2026