Full-text search for pages the authenticated user can access. Optionally scope to a space.

Get a page's metadata and Markdown body. Use format=json for raw ProseMirror.

Create a page in a space. Body is Markdown and is persisted in place (Docmost v0.71+). Can nest under a parent.

Update a page title, icon, and/or Markdown body in place. Body writes use the server converter (v0.71+). operation defaults to replace.

List pages in a space. Default view=recent is recently updated pages (not the sidebar tree; General can look empty). Use view=tree for space-root pages in sidebar order, or list_child_pages for children of a page.

List direct child pages of a page, in sidebar order. Omit page_id and pass space_id for space-root pages.

Duplicate a page and its accessible sub-pages within the same space.

Copy a page and its accessible sub-pages into a different space.

Move a page under a new parent or to the space root. Position is computed unless you pass an explicit 5-12 character key.

Move a page and its accessible sub-pages to a different space.

Move a page to trash, or permanently delete it. Permanent delete requires space admin.

Restore a soft-deleted page from trash.

List soft-deleted pages in a space.

List revision history for a page.

Get a specific page history version by history ID.

Get the ancestor path from space root to a page.

List incoming or outgoing page links.

Export a page to a local file. A page without children is often a .md or .html file; include_children usually returns a zip. Writes to output_path or a temp file and returns the path plus content type.

List spaces the authenticated user can access.

Get details for a space, including the current user's membership.

Create a space. Slug is generated from the name if omitted. Requires permission to manage spaces.

Update a space name, slug, or description.

Delete a space and its pages. This cannot be undone.

Export a whole space as a zip of Markdown or HTML. Writes to output_path or a temp file.

List page-level comments. Content is returned as Markdown. Each comment is re-fetched so edits are not stale.

Add a page-level comment. Inline selection comments are not supported.

Replace a comment body. You can update your own comments.

Delete a comment. Owners can delete their own; space admins can delete any comment.

Search file attachments by name or indexed text. This is an Enterprise feature; Community Edition returns 403. Prefer get_attachment_info when you already have an attachment id.

Typeahead suggestions. Pages are included by default (set include_pages=false to skip). Users and groups default to off.

Get the authenticated user and workspace context, detected Docmost version, and whether this session is read-only.

List workspace members.

Upload a local file to a page. Returns attachment metadata including the /api/files/:id/:name URL path.

Get metadata for an uploaded attachment.

List labels on a page.

Add one or more labels to a page. Names are normalized to lowercase kebab-case.

Remove a label from a page by label ID.

List members and groups in a space.

Add users and/or groups to a space with a role.

Remove a user or group from a space.

Change a space member or group's role.