All Documents

Summary

Fetches content from any document in the space. Use 'id' query parameter to specify which block to fetch.

Use Accept header application/json for structured data, text/markdown for rendered content.

Content Rendering: Text blocks contain markdown formatting and may include Craft-specific structural tags (e.g. <page>, <callout>, <highlight>). See the Craft Markdown Extensions section in the API description for the full list of tags.

Full Space Access: This connection has access to all documents across all locations in the space. Block links and relations within the space are preserved.

Tip: Start with GET /folders to see all locations, then GET /documents to list documents by location. Use the returned rootBlockIds as the 'id' parameter to fetch content.

Summary

Insert content into any document in the space. Content can be provided as structured JSON blocks. Use position parameter to specify where to insert (via parent blockId, sibling blockId, or daily-note date). Returns the inserted blocks with their assigned block IDs for later reference.

Summary

Delete content from any document in the space. Removes specified blocks by their IDs.

Summary

Update content in any document in the space. For text blocks, provide updated markdown content. Only the fields that are provided will be updated.

Summary

Move blocks to reorder them or move them between any documents across all locations in the space. Returns the moved block IDs.

Summary

Get all items from a collection

Summary

Add new items to a collection. Two-way relations are synced automatically in the background - only set one side for consistency.

Summary

Delete collection items (also deletes content inside items)

Summary

Update collection items. Two-way relations are synced automatically in the background - only set one side for consistency.

Summary

Set the collection-level activeViewId to one existing collection view ID. This only changes which stored view is marked active; it does not execute the view or change collection items.

Summary

List table, gallery, and kanban view definitions for a collection. This returns configuration only; it does not execute filters/sorts/groups or return collection items. If activeViewId is missing or invalid, the first stored view is treated as active.

Summary

Create a collection view definition. Use type table for the regular/default table layout, gallery for card layouts, or kanban for grouped boards. This creates configuration only; it does not create or return collection items. Kanban requires exactly one group rule.

Summary

Delete one collection view definition by view ID. Cannot delete the last stored view in a collection. If the active view is deleted, the first remaining stored view becomes active.

Summary

Update one collection view definition by view ID. Omitted settings are preserved. Pass empty arrays or objects to clear list-like settings. Gallery settings are only valid for gallery views; kanban settings are only valid for kanban views.

Summary

List all collections across the entire space. Returns collections from all documents regardless of their location.

Summary

Create a new collection (structured table) in any document in the space. Define the schema with columns and their types.

Summary

Get collection schema in JSON Schema format

Summary

Update the collection schema. Replaces the existing schema entirely - include all fields you want to keep. Keep property keys stable for existing properties.

Summary

Add comments to blocks.

Summary

Returns connection metadata including space ID, space name, timezone, current time, and URL templates for constructing deep links to blocks.

Summary

List documents in the space. Without location or folderIds filters, returns ALL documents (may be large). Recommended: use GET /folders first to see available locations and document counts.

Summary

Create one or more documents in the space. Specify location as 'unsorted' (default), 'templates' (in-app template docs), or provide a folderId. Cannot create in 'trash'.

Summary

Soft-delete documents by moving them to trash. Use documents_move to restore.

Summary

Move documents between locations in the space. Destination cannot be 'trash' - use documents_delete instead. Use this to restore documents from trash. Note: Daily notes cannot be moved.

Summary

Experimental: list block reminders within this connection's document scope. See the Reminders section for availability and ownership.

Summary

Experimental: set or replace reminders on blocks within this connection's document scope. Omit the time to Save for later.

Summary

Experimental: delete block reminders within this connection's document scope. The blocks themselves are not deleted.

Summary

Experimental: update block reminders within this connection's document scope. Only provided fields are changed.

Summary

Get all locations in the space with document counts. Returns built-in locations (Unsorted, Trash, Templates) and user-created folders with their hierarchical structure.

Summary

Create one or more folders. Supports creating at root level or nested inside existing folders. Cannot create inside built-in locations.

Summary

Delete folders. Documents and subfolders are moved to the parent folder, or Unsorted if deleting a top-level folder. Cannot delete built-in locations.

Summary

Move folders within the hierarchy. Supports moving to root or inside another folder. Cannot move built-in locations.

Summary

Search within a single document. Use documents_search first to find documents, then this tool for more context with before/after blocks.

Summary

Search content across all documents in the space using relevance-based ranking. Supports flat date filter fields (createdDateGte, createdDateLte, lastModifiedDateGte, lastModifiedDateLte, dailyNoteDateGte, dailyNoteDateLte) for time-based queries and location object for filtering by folder.

• Searches the entire space (all locations)
• Relevance-based ranking (top 20 results)
• Content snippets with match highlighting
• Filter by date ranges or location

Example Use Cases:

• Find all mentions of a topic anywhere in the space
• Search for specific content across all documents
• Search documents within a specific location or folder

Summary

Retrieve tasks from across the space. Use scope='document' with documentId to get tasks from a specific document. scope='all' returns every task block in the full space, across all documents and states; it is not a union of active, upcoming, inbox, and logbook.

Summary

Create new tasks in inbox, daily notes, or specific documents. Location types: 'inbox', 'dailyNote' (with date), or 'document' (with documentId). Tasks can include schedule dates and deadlines.

Summary

Delete tasks by their IDs from any location in the space.

Summary

Update existing tasks across the space. Can modify task content, state, schedule dates, deadlines, and location (to move tasks). Location types: 'inbox', 'dailyNote' (with date), or 'document' (with documentId). Marking inbox tasks as done/canceled moves them to logbook.

Summary

Upload a file (image, video, or document) and insert it at the specified position. Requires explicit target (pageId, siblingId, or date). Send raw binary data in request body with Content-Type header.

Summary

Create a new empty whiteboard block at the specified position. Returns the whiteboard block ID. Use whiteboardElements_add to populate it.

Summary

Get all Excalidraw elements and appState from a whiteboard block.

Summary

Append elements to an existing whiteboard without removing existing ones.

Summary

Remove elements from a whiteboard by their Excalidraw element IDs.

Summary

Update specific elements in a whiteboard by their ID. Elements not included in the request remain unchanged.