List a surface's blocks in document order
Returns a window of the surface's block tree flattened into depth-first document order, together with the workspace version the window was read at. Requires `surfaces:read` on the surface. Paginated: pass `limit` (default 200, maximum 500) and the `cursor` from the previous response; a cursor that does not decode is rejected as a validation error.
Authorization
apiKey Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Path Parameters
Query Parameters
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/workspaces/string/surfaces/string/blocks"{ "data": { "surfaceId": "string", "workspaceVersion": 0, "blocks": [ { "id": "string", "workspaceId": "string", "surfaceId": "string", "parentBlockId": "string", "kind": "paragraph", "orderKey": "string", "manifest": {}, "layout": { "x": 0, "y": 0, "w": 0, "h": 0, "tab": "string" }, "plainText": "string", "createdAt": "string", "updatedAt": "string" } ], "window": { "cursor": "string", "hasMore": true } }}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}Preview what deleting a surface would affect
Returns the dependency impact report for the surface: the dependents that block deletion and the ones that are only warnings. Requires read access to the surface. Use it before `delete` to decide whether the confirmation flag is needed.
Render a page against a record for printing
Resolves the page or note surface and the record named by `recordId` independently, then returns a print-ready render of the page with the record's values substituted, laid out for the requested `preset` (`a4` or `80mm`, default `a4`). The caller must have read access to both the surface and the record; surfaces of any other kind are rejected as a validation error.