Seiten

Seiten anlegen, verschieben, in den Papierkorb legen und zurückholen; dazu ihre Markdown-Oberfläche, Feldwerte, Relationen, Backlinks, die Suche und die angehefteten Seiten.

28 Operationen. Jeder Pfad ist relativ zum Ursprung der Instanz; jeder Antwortkörper ist JSON, sofern nicht anders vermerkt. Die Endpunktbeschreibungen unten stammen unverändert aus der Routentabelle des Servers und bleiben englisch. Authentifizierung, Fehler und seitenweise Abfrage stehen unter API.

GET /api/v1/workspaces/{workspaceId}/pages

List child pages of a parent page, or the top level of a collection. Each entry carries hasChildren — whether this CALLER would find at least one live child below it, resolved through the same permission filter as the listing (ADR-0016 D9), so a chevron can never disclose a child the caller may not read.

listPages · token scope: content:read

Path parameters

• workspaceId · string (uuid) — required

Query parameters

• cursor · string — length 1–∞
• limit · integer — 1–100
• collectionId · string (uuid)
• parentPageId · string (uuid)

Response 200 — application/json

• items · object[] — required
  • id · string (uuid) — required
  • workspaceId · string (uuid) — required
  • collectionId · string (uuid) — required
  • parentPageId · string (uuid) | null — required
  • position · string — required
  • title · string — required
  • icon · string | null — required
  • cover · string | null — required
  • createdBy · string (uuid) | null — required
  • updatedBy · string (uuid) | null — required
  • createdAt · string (date-time) — required
  • updatedAt · string (date-time) — required
  • deletedAt · string (date-time) | null — required
  • restricted · boolean — required
  • hasChildren · boolean — required
  • summary · string | null — required, default null
• nextCursor · string | null — required

Response default — application/json

• error · object — required
  • code · "bad_request" | "validation_failed" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "rate_limited" | "internal" — required
  • message · string — required
  • reason · string — length 1–64

POST /api/v1/workspaces/{workspaceId}/pages

Create a page in a collection, optionally under a parent page.

createPage · token scope: content:write

Path parameters

• workspaceId · string (uuid) — required

Request body — application/json, required

• collectionId · string (uuid) — required
• parentPageId · string (uuid)
• title · string — required, length 0–1000
• icon · string — length 0–2048

Response 200 — application/json

• id · string (uuid) — required
• workspaceId · string (uuid) — required
• collectionId · string (uuid) — required
• parentPageId · string (uuid) | null — required
• position · string — required
• title · string — required
• icon · string | null — required
• cover · string | null — required
• createdBy · string (uuid) | null — required
• updatedBy · string (uuid) | null — required
• createdAt · string (date-time) — required
• updatedAt · string (date-time) — required
• deletedAt · string (date-time) | null — required
• restricted · boolean — required

Response default — application/json

• error · object — required
  • code · "bad_request" | "validation_failed" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "rate_limited" | "internal" — required
  • message · string — required
  • reason · string — length 1–64

GET /api/v1/workspaces/{workspaceId}/pages/{pageId}

Get a single page. Default representation is JSON; ?format=markdown returns the page body as canonical Markdown (text/markdown) with an ETag (ADR-0012).

getPage · token scope: content:read

Path parameters

• workspaceId · string (uuid) — required
• pageId · string (uuid) — required

Query parameters

• format · "markdown"

Response 200 — application/json

• id · string (uuid) — required
• workspaceId · string (uuid) — required
• collectionId · string (uuid) — required
• parentPageId · string (uuid) | null — required
• position · string — required
• title · string — required
• icon · string | null — required
• cover · string | null — required
• createdBy · string (uuid) | null — required
• updatedBy · string (uuid) | null — required
• createdAt · string (date-time) — required
• updatedAt · string (date-time) — required
• deletedAt · string (date-time) | null — required
• restricted · boolean — required

Response default — application/json

• error · object — required
  • code · "bad_request" | "validation_failed" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "rate_limited" | "internal" — required
  • message · string — required
  • reason · string — length 1–64

PUT /api/v1/workspaces/{workspaceId}/pages/{pageId}

Replace a page body from canonical Markdown (text/markdown; ADR-0012). Parses to blocks and applies them through the doc mutator in one Yjs transaction. Supports If-Match/ETag optimistic concurrency (412 on mismatch); returns the stored canonical Markdown.

updatePageMarkdown · token scope: content:write

Path parameters

• workspaceId · string (uuid) — required
• pageId · string (uuid) — required

Query parameters

• format · "markdown"

Request body — application/json, required

• string

Response 200 — application/json

• string

Response default — application/json

• error · object — required
  • code · "bad_request" | "validation_failed" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "rate_limited" | "internal" — required
  • message · string — required
  • reason · string — length 1–64

PATCH /api/v1/workspaces/{workspaceId}/pages/{pageId}

Update page title and/or icon.

updatePage · token scope: content:write

Path parameters

• workspaceId · string (uuid) — required
• pageId · string (uuid) — required

Request body — application/json, required

• title · string — length 0–1000
• icon · string | null

Response 200 — application/json

• id · string (uuid) — required
• workspaceId · string (uuid) — required
• collectionId · string (uuid) — required
• parentPageId · string (uuid) | null — required
• position · string — required
• title · string — required
• icon · string | null — required
• cover · string | null — required
• createdBy · string (uuid) | null — required
• updatedBy · string (uuid) | null — required
• createdAt · string (date-time) — required
• updatedAt · string (date-time) — required
• deletedAt · string (date-time) | null — required
• restricted · boolean — required

Response default — application/json

• error · object — required
  • code · "bad_request" | "validation_failed" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "rate_limited" | "internal" — required
  • message · string — required
  • reason · string — length 1–64

POST /api/v1/workspaces/{workspaceId}/pages/{pageId}/move

Move a page to a new canonical parent and/or sibling position. Returns the moved page plus an ADVISORY accessDiff (ADR-0016 D12): the subjects who gained and lost access, computed AFTER the move. A move is never refused on permission grounds — the UI surfaces the diff as a notice.

movePage · token scope: content:write

Path parameters

• workspaceId · string (uuid) — required
• pageId · string (uuid) — required

Request body — application/json, required

• parentPageId · string (uuid) | null — required
• collectionId · string (uuid)
• beforeId · string (uuid)
• afterId · string (uuid)

Response 200 — application/json

• id · string (uuid) — required
• workspaceId · string (uuid) — required
• collectionId · string (uuid) — required
• parentPageId · string (uuid) | null — required
• position · string — required
• title · string — required
• icon · string | null — required
• cover · string | null — required
• createdBy · string (uuid) | null — required
• updatedBy · string (uuid) | null — required
• createdAt · string (date-time) — required
• updatedAt · string (date-time) — required
• deletedAt · string (date-time) | null — required
• restricted · boolean — required
• accessDiff · object — required
  • gained · object[] — required
    • subjectType · "user" | "group" — required
    • subjectId · string (uuid) — required
    • name · string — required
    • image · string | null — required
  • lost · object[] — required
    • subjectType · "user" | "group" — required
    • subjectId · string (uuid) — required
    • name · string — required
    • image · string | null — required

Response default — application/json

• error · object — required
  • code · "bad_request" | "validation_failed" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "rate_limited" | "internal" — required
  • message · string — required
  • reason · string — length 1–64

POST /api/v1/workspaces/{workspaceId}/pages/{pageId}/duplicate

Duplicate a page as a new sibling placed right after it: title, icon, field values (props) and body doc are copied, and the whole canonical page subtree comes along. The root copy is titled by the request title when given (verbatim — localize it client-side); otherwise the server falls back to the source title suffixed "(copy)". Every copied block gets a FRESH id — the copy shares nothing with the original. Databases, views and relation links inside the subtree are NOT copied; database memberships of the duplicated page itself are (the copy stays a row of the same databases). Refuses (400) above DUPLICATE_PAGE_MAX_PAGES / DUPLICATE_PAGE_MAX_DEPTH. Returns the new root page.

duplicatePage · token scope: content:write

Path parameters

• workspaceId · string (uuid) — required
• pageId · string (uuid) — required

Request body — application/json, required

• title · string — length 0–1000
• databaseIds · string (uuid)[]

Response 200 — application/json

• id · string (uuid) — required
• workspaceId · string (uuid) — required
• collectionId · string (uuid) — required
• parentPageId · string (uuid) | null — required
• position · string — required
• title · string — required
• icon · string | null — required
• cover · string | null — required
• createdBy · string (uuid) | null — required
• updatedBy · string (uuid) | null — required
• createdAt · string (date-time) — required
• updatedAt · string (date-time) — required
• deletedAt · string (date-time) | null — required
• restricted · boolean — required

Response default — application/json

• error · object — required
  • code · "bad_request" | "validation_failed" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "rate_limited" | "internal" — required
  • message · string — required
  • reason · string — length 1–64

POST /api/v1/workspaces/{workspaceId}/pages/{pageId}/trash

Soft-delete a page (move to trash).

trashPage · token scope: content:write

Path parameters

• workspaceId · string (uuid) — required
• pageId · string (uuid) — required

Response 200 — application/json

• id · string (uuid) — required
• workspaceId · string (uuid) — required
• collectionId · string (uuid) — required
• parentPageId · string (uuid) | null — required
• position · string — required
• title · string — required
• icon · string | null — required
• cover · string | null — required
• createdBy · string (uuid) | null — required
• updatedBy · string (uuid) | null — required
• createdAt · string (date-time) — required
• updatedAt · string (date-time) — required
• deletedAt · string (date-time) | null — required
• restricted · boolean — required

Response default — application/json

• error · object — required
  • code · "bad_request" | "validation_failed" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "rate_limited" | "internal" — required
  • message · string — required
  • reason · string — length 1–64

POST /api/v1/workspaces/{workspaceId}/pages/{pageId}/restore

Restore a doc root (page, outline or board) from the trash, together with the batch that was trashed with it. Restoring a board brings its backing database back into reach (it was hidden by the trashed-ancestor rule, never itself trashed).

restorePage · token scope: content:write

Path parameters

• workspaceId · string (uuid) — required
• pageId · string (uuid) — required

Response 200 — application/json

• id · string (uuid) — required
• workspaceId · string (uuid) — required
• collectionId · string (uuid) — required
• parentPageId · string (uuid) | null — required
• position · string — required
• title · string — required
• icon · string | null — required
• cover · string | null — required
• createdBy · string (uuid) | null — required
• updatedBy · string (uuid) | null — required
• createdAt · string (date-time) — required
• updatedAt · string (date-time) — required
• deletedAt · string (date-time) | null — required
• restricted · boolean — required

Response default — application/json

• error · object — required
  • code · "bad_request" | "validation_failed" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "rate_limited" | "internal" — required
  • message · string — required
  • reason · string — length 1–64

GET /api/v1/workspaces/{workspaceId}/trash

List the workspace's trash (deleted_at set), most-recently trashed first. Only the roots of each trashed subtree are returned — entries whose canonical parent is itself trashed are omitted, so restoring a listed entry brings back its whole batch. Covers every trashed doc root (PAGES, OUTLINES, BOARDS) and trashed DATABASES in one list; resourceType says which one an entry is (and therefore which restore / permanent-delete route applies: databases have their own pair, the doc roots share the page routes). A database/outline/board entry carries its name in title. Scoped to the product the request came from (ADR-0030), like emptyTrash and by the same predicate — the list and the number confirmed against it can never drift apart. Workspace-scoped; auth + membership guarded.

listTrashedPages · token scope: content:read

Path parameters

• workspaceId · string (uuid) — required

Query parameters

• cursor · string — length 1–∞
• limit · integer — 1–100

Response 200 — application/json

• items · object[] — required
  • id · string (uuid) — required
  • workspaceId · string (uuid) — required
  • collectionId · string (uuid) — required
  • parentPageId · string (uuid) | null — required
  • position · string — required
  • title · string — required
  • icon · string | null — required
  • cover · string | null — required
  • createdBy · string (uuid) | null — required
  • updatedBy · string (uuid) | null — required
  • createdAt · string (date-time) — required
  • updatedAt · string (date-time) — required
  • deletedAt · string (date-time) | null — required
  • restricted · boolean — required
  • resourceType · "page" | "database" | "outline" | "board" — required
• nextCursor · string | null — required

Response default — application/json

• error · object — required
  • code · "bad_request" | "validation_failed" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "rate_limited" | "internal" — required
  • message · string — required
  • reason · string — length 1–64

GET /api/v1/workspaces/{workspaceId}/trash/summary

Count the workspace trash: how many trashed subtree ROOTS listTrashedPages would return in total (same predicate, unpaginated). emptyTrash purges all of them, so a confirmation must not count the one paginated page the client happens to hold. Workspace-scoped; auth + membership guarded.

getTrashSummary · token scope: content:read

Path parameters

• workspaceId · string (uuid) — required

Response 200 — application/json

• entries · integer — required, 0–9007199254740991

Response default — application/json

• error · object — required
  • code · "bad_request" | "validation_failed" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "rate_limited" | "internal" — required
  • message · string — required
  • reason · string — length 1–64

DELETE /api/v1/workspaces/{workspaceId}/pages/{pageId}/permanent

Permanently delete a TRASHED doc root (page, outline or board) and everything below it — irreversible. Refuses with 409 when the target is not in the trash (trash it first). The cascade removes the whole canonical subtree: db_row memberships (as row and, for purged databases, as container), relation_link rows in BOTH directions (including the symmetric mirror), database_field bindings of purged databases, block_link edges in both directions, permissions/public shares, the search projection, the stored Yjs doc + update tail, and every structure- and doc-plane block row. Views targeting a purged database are removed too, wherever in the workspace they live — a saved query whose table is gone. Returns what was deleted, broken out by pages/databases/views.

deletePagePermanently · token scope: content:write

Path parameters

• workspaceId · string (uuid) — required
• pageId · string (uuid) — required

Response 200 — application/json

• roots · integer — required, 0–9007199254740991
• pages · integer — required, 0–9007199254740991
• databases · integer — required, 0–9007199254740991
• views · integer — required, 0–9007199254740991
• blocks · integer — required, 0–9007199254740991

Response default — application/json

• error · object — required
  • code · "bad_request" | "validation_failed" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "rate_limited" | "internal" — required
  • message · string — required
  • reason · string — length 1–64

POST /api/v1/workspaces/{workspaceId}/trash/empty

Permanently delete every trashed subtree root THE ASKING PRODUCT can see (ADR-0030 — emptying the trash here never touches a document another product on this instance holds) — nothing it removes is recoverable. Applies exactly the cascade of deletePagePermanently to each root, including trashed databases and views (which never appear in the trash listing but would otherwise linger forever). Idempotent: emptying an empty trash deletes nothing and returns zeroes. Use getTrashSummary for the entry count to confirm against — the trash listing is paginated, this route is not scoped to a page of it.

emptyTrash · token scope: content:write

Path parameters

• workspaceId · string (uuid) — required

Response 200 — application/json

• roots · integer — required, 0–9007199254740991
• pages · integer — required, 0–9007199254740991
• databases · integer — required, 0–9007199254740991
• views · integer — required, 0–9007199254740991
• blocks · integer — required, 0–9007199254740991

Response default — application/json

• error · object — required
  • code · "bad_request" | "validation_failed" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "rate_limited" | "internal" — required
  • message · string — required
  • reason · string — length 1–64

GET /api/v1/workspaces/{workspaceId}/search

Full-text search over doc-root titles and bodies in a workspace. Each hit carries kind — which doc root it is — so a client routes it instead of guessing. Scoped to the PRODUCT the request came from (ADR-0030): a browser request is answered with the documents that product presents and no others. A request whose product cannot be resolved from the operator-configured origin allowlist — a personal access token, notably — is answered with everything the caller may read.

searchWorkspace · token scope: content:read

Path parameters

• workspaceId · string (uuid) — required

Query parameters

• q · string — required, length 1–500
• limit · integer — 1–50

Response 200 — application/json

• items · object[] — required
  • id · string (uuid) — required
  • kind · "page" | "outline" | "board" — required
  • title · string — required
  • snippet · string — required
  • summary · string | null — required, default null

Response default — application/json

• error · object — required
  • code · "bad_request" | "validation_failed" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "rate_limited" | "internal" — required
  • message · string — required
  • reason · string — length 1–64

GET /api/v1/workspaces/{workspaceId}/favorites

The calling user's pinned pages in this workspace, in order. Filtered to what they may currently read, so a page whose access was withdrawn stops being listed without the pin itself being lost.

listFavorites · token scope: content:read

Path parameters

• workspaceId · string (uuid) — required

Response 200 — application/json

• items · object[] — required
  • pageId · string (uuid) — required
  • title · string — required
  • icon · string | null — required
  • position · string — required
  • createdAt · string (date-time) — required

Response default — application/json

• error · object — required
  • code · "bad_request" | "validation_failed" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "rate_limited" | "internal" — required
  • message · string — required
  • reason · string — length 1–64

POST /api/v1/workspaces/{workspaceId}/favorites

Pin a page for the calling user. Requires read on the page — pinning is a bookmark, not a grant. Refuses past 5 pinned pages.

addFavorite · token scope: content:write

Path parameters

• workspaceId · string (uuid) — required

Request body — application/json, required

• pageId · string (uuid) — required
• beforeId · string (uuid)

Response 200 — application/json

• pageId · string (uuid) — required
• title · string — required
• icon · string | null — required
• position · string — required
• createdAt · string (date-time) — required

Response default — application/json

• error · object — required
  • code · "bad_request" | "validation_failed" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "rate_limited" | "internal" — required
  • message · string — required
  • reason · string — length 1–64

DELETE /api/v1/workspaces/{workspaceId}/favorites/{pageId}

Unpin a page for the calling user.

removeFavorite · token scope: content:write

Path parameters

• workspaceId · string (uuid) — required
• pageId · string (uuid) — required

Response 200 — application/json

• ok · true — required

Response default — application/json

• error · object — required
  • code · "bad_request" | "validation_failed" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "rate_limited" | "internal" — required
  • message · string — required
  • reason · string — length 1–64

POST /api/v1/workspaces/{workspaceId}/favorites/{pageId}/move

Reorder a pinned page within the calling user's own list.

moveFavorite · token scope: content:write

Path parameters

• workspaceId · string (uuid) — required
• pageId · string (uuid) — required

Request body — application/json, required

• beforeId · string (uuid)
• afterId · string (uuid)

Response 200 — application/json

• pageId · string (uuid) — required
• title · string — required
• icon · string | null — required
• position · string — required
• createdAt · string (date-time) — required

Response default — application/json

• error · object — required
  • code · "bad_request" | "validation_failed" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "rate_limited" | "internal" — required
  • message · string — required
  • reason · string — length 1–64

GET /api/v1/workspaces/{workspaceId}/pages/{pageId}/boards

The boards a page is a card on, seen from the page's side — the reverse of the grouped read. Each entry names the board and the membership's column/lane on it (ADR-0025 D3; null = unplaced). Requires read on the page; boards the caller may not read (or that are trashed) are omitted, not stubbed (ADR-0016 D9). Newest board first, like the board listing.

listCardBoards · token scope: content:read

Path parameters

• workspaceId · string (uuid) — required
• pageId · string (uuid) — required

Response 200 — application/json

• items · object[] — required
  • boardId · string (uuid) — required
  • title · string — required
  • icon · string | null — required
  • collectionId · string (uuid) — required
  • columnId · string (uuid) | null — required
  • laneId · string (uuid) | null — required

Response default — application/json

• error · object — required
  • code · "bad_request" | "validation_failed" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "rate_limited" | "internal" — required
  • message · string — required
  • reason · string — length 1–64

GET /api/v1/workspaces/{workspaceId}/pages/{pageId}/backlinks

List the pages that link to this page ("Linked from"). Resolves inline block_link rows targeting the page back to their source pages (distinct, trashed sources skipped). Workspace-scoped; auth + membership guarded.

getPageBacklinks · token scope: content:read

Path parameters

• workspaceId · string (uuid) — required
• pageId · string (uuid) — required

Response 200 — application/json

• items · object[] — required
  • pageId · string (uuid) — required
  • title · string — required

Response default — application/json

• error · object — required
  • code · "bad_request" | "validation_failed" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "rate_limited" | "internal" — required
  • message · string — required
  • reason · string — length 1–64

GET /api/v1/workspaces/{workspaceId}/blocks/{blockId}/references

List where a single block is referenced: the distinct readable pages that transclude it (block_ref) — and, when the block is a page, the pages that link or embed it — each with the number of references it carries, plus the readable total. Requires read on the target block; the source pages are filtered inside the same statement that finds them (ADR-0016 D9/D9a), and the counts come from that filtered set.

getBlockReferences · token scope: content:read

Path parameters

• workspaceId · string (uuid) — required
• blockId · string (uuid) — required

Response 200 — application/json

• items · object[] — required
  • pageId · string (uuid) — required
  • title · string — required
  • count · integer — required, −∞–9007199254740991
• count · integer — required, 0–9007199254740991

Response default — application/json

• error · object — required
  • code · "bad_request" | "validation_failed" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "rate_limited" | "internal" — required
  • message · string — required
  • reason · string — length 1–64

GET /api/v1/workspaces/{workspaceId}/pages/{pageId}/referenced-blocks

List the blocks OF this page that are referenced from elsewhere, with a short excerpt and how often each is referenced ("Referenced blocks"). Requires read on the page; the referencing blocks are permission-filtered before they are counted, so both the per-block counts and the total are what the CALLER may see (ADR-0016 D9) — a count taken over unreadable sources would be a counting oracle for restricted pages.

getPageReferencedBlocks · token scope: content:read

Path parameters

• workspaceId · string (uuid) — required
• pageId · string (uuid) — required

Response 200 — application/json

• items · object[] — required
  • blockId · string (uuid) — required
  • type · "page" | "database" | "db_view" | "page_ref" | "outline" | "board" | "paragraph" | "heading" | "list_item" | "todo" | "toggle" | "callout" | "quote" | "code" | "divider" | "image" | "table" | "block_ref" — required
  • excerpt · string — required
  • count · integer — required, −∞–9007199254740991
• count · integer — required, 0–9007199254740991

Response default — application/json

• error · object — required
  • code · "bad_request" | "validation_failed" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "rate_limited" | "internal" — required
  • message · string — required
  • reason · string — length 1–64

GET /api/v1/workspaces/{workspaceId}/blocks/{blockId}/ref-target

Resolve a block reference: the page that canonically owns the block, plus whether the viewer may read it and whether it is trashed. Powers read-only block transclusion (block_ref). Workspace-scoped; auth + membership guarded.

resolveBlockRef · token scope: content:read

Path parameters

• workspaceId · string (uuid) — required
• blockId · string (uuid) — required

Response 200 — application/json

• pageId · string (uuid) | null — required
• accessible · boolean — required
• deleted · boolean — required

Response default — application/json

• error · object — required
  • code · "bad_request" | "validation_failed" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "rate_limited" | "internal" — required
  • message · string — required
  • reason · string — length 1–64

GET /api/v1/workspaces/{workspaceId}/pages/{pageId}/fields

The fields available on a page: its workspace, collection and database bindings combined.

getPageFields · token scope: content:read

Path parameters

• workspaceId · string (uuid) — required
• pageId · string (uuid) — required

Response 200 — application/json

• pageId · string (uuid) — required
• bindings · object[] — required
  • workspaceId · string (uuid) — required
  • scopeType · "workspace" | "collection" | "database" — required
  • scopeId · string (uuid) — required
  • fieldId · string (uuid) — required
  • position · string — required
  • required · boolean — required
  • defaultValue · object | null — required

Response default — application/json

• error · object — required
  • code · "bad_request" | "validation_failed" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "rate_limited" | "internal" — required
  • message · string — required
  • reason · string — length 1–64

GET /api/v1/workspaces/{workspaceId}/pages/{pageId}/props

Read a page's field values (props), including read-only relation/formula cells.

getPageProps · token scope: content:read

Path parameters

• workspaceId · string (uuid) — required
• pageId · string (uuid) — required

Response 200 — application/json

• pageId · string (uuid) — required
• cells · object — required

Response default — application/json

• error · object — required
  • code · "bad_request" | "validation_failed" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "rate_limited" | "internal" — required
  • message · string — required
  • reason · string — length 1–64

PATCH /api/v1/workspaces/{workspaceId}/pages/{pageId}/props

Set a page's field values (a null value clears a cell). Validates option ids and member ids (M1). Uniform across tree pages and every database.

updatePageProps · token scope: content:write

Path parameters

• workspaceId · string (uuid) — required
• pageId · string (uuid) — required

Request body — application/json, required

• cells · object — required

Response 200 — application/json

• pageId · string (uuid) — required
• cells · object — required

Response default — application/json

• error · object — required
  • code · "bad_request" | "validation_failed" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "rate_limited" | "internal" — required
  • message · string — required
  • reason · string — length 1–64

GET /api/v1/workspaces/{workspaceId}/pages/{pageId}/relations

Read a page's relation values, grouped by relation field id.

getPageRelations · token scope: content:read

Path parameters

• workspaceId · string (uuid) — required
• pageId · string (uuid) — required

Response 200 — application/json

• pageId · string (uuid) — required
• relations · object — required

Response default — application/json

• error · object — required
  • code · "bad_request" | "validation_failed" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "rate_limited" | "internal" — required
  • message · string — required
  • reason · string — length 1–64

PUT /api/v1/workspaces/{workspaceId}/pages/{pageId}/relations/{fieldId}

Replace the target set of one relation field on a page. Writes the symmetric back-reference when the field config declares one. Replaces only the targets this caller can read: a target withheld by permissions or by the asking product (ADR-0030) is kept, because a client cannot mean to remove a link it was never shown.

setPageRelations · token scope: content:write

Path parameters

• workspaceId · string (uuid) — required
• pageId · string (uuid) — required
• fieldId · string (uuid) — required

Request body — application/json, required

• targetPageIds · string (uuid)[] — required

Response 200 — application/json

• pageId · string (uuid) — required
• fieldId · string (uuid) — required
• targets · object[] — required
  • pageId · string (uuid) — required
  • title · string — required

Response default — application/json

• error · object — required
  • code · "bad_request" | "validation_failed" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "rate_limited" | "internal" — required
  • message · string — required
  • reason · string — length 1–64