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/domains

Method Path Access What it does
GET /api/domains Session —
POST /api/domains Session —
PATCH /api/domains/:id Session —
DELETE /api/domains/:id Session —
GET /api/domains/:id/subscribers Session —
POST /api/domains/:id/subscribers Session Adds a pasted list. Each line can be "email", "email, Name" or "Name <email>". The site owner confirms they have consent, so these become active without a confirmation email.
DELETE /api/domains/:id/subscribers/:subscriberId Session Permanently removes the address from this domain's list, including its delivery history.
GET /api/domains/:id/subscribers/export Session —
POST /api/domains/:id/test Session Sends the draft to one address so it can be checked in a real inbox. Nothing is recorded.
GET /api/domains/:id/updates Session —
POST /api/domains/:id/updates Session Creates the update; the browser then calls /api/updates/:id/send until every subscriber has it.

/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 —

/api/provision

Method Path Access What it does
GET /api/provision/nextjs Public The site key is public by design (it ships in every page's HTML), so this needs no session.

/api/subscribe

Method Path Access What it does
OPTIONS /api/subscribe Public Any website may post here, so CORS is open; responses carry no private data.
POST /api/subscribe Public Any website may post here, so CORS is open; responses carry no private data.
GET /api/subscribe Public Any website may post here, so CORS is open; responses carry no private data.

/api/unsubscribe

Method Path Access What it does
POST /api/unsubscribe Public Handles both the button on /unsubscribe and RFC 8058 one-click requests, which mailbox providers send as a POST with the body "List-Unsubscribe=One-Click".
GET /api/unsubscribe Public Link scanners and older mail clients open the URL with GET; show the confirmation page instead of acting.

/api/updates

Method Path Access What it does
POST /api/updates/:id/retry Session Queues failed recipients again; the browser then resumes sending with /send.
POST /api/updates/:id/send Session Sends the next chunk of one update through Cloudflare Email Service and reports progress. One bad address only fails that recipient. Rate limits, the daily quota and setup errors stop the chunk; unsent recipients go back in the queue so the update can be resum

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
/ —
/confirm Target of the link in the confirmation email (double opt-in).
/domains —
/domains/:id —
/edit —
/item/:slug —
/item/:slug/workspace —
/s/:domain Hosted sign-up page for one domain's list; domains with subscribe.<domain> also serve it there.
/unsubscribe Shows a button instead of unsubscribing on load, because link scanners open every URL in an email. Mail apps' one-click unsubscribe posts straight to /api/unsubscribe.
Last updated 2 November 2026