HTTP API

Reference

Docs API

Endpoints for Docs spaces and pages: members, the page tree, page content, revisions, Trash and search.

This group covers Docs spaces and their pages: space and page members, the page tree, page content and revisions, Trash, stars and search. Every call acts as a person: send a personal access token, or an OAuth access token from a person's sign-in (scope Volobox). An integration app's own client secret is refused with 403 (Volobox:Integrations:MemberConnectionRequired). Paths, tokens and conventions are in API overview.

Docs spaces

GET/api/v1/docs
Lists the Docs spaces the caller can open.
docs.getList
POST/api/v1/docs
Creates a Docs space with the caller as its admin.
docs.create
GET/api/v1/docs/{id}
Gets a Docs space the caller can open.
docs.get
PUT/api/v1/docs/{id}
Updates a Docs space the caller administers.
docs.update
DELETE/api/v1/docs/{id}
Moves an archived Docs space to Trash.
docs.delete
POST/api/v1/docs/{id}/archive
Archives a Docs space, hiding it and its pages everywhere until it is restored.
docs.archive
DELETE/api/v1/docs/{id}/permanent
Permanently deletes a Docs space in Trash with all its pages.
docs.deletePermanently
POST/api/v1/docs/{id}/restore
Restores an archived Docs space.
docs.restore
POST/api/v1/docs/{id}/restore-from-trash
Restores a Docs space from Trash to the archive.
docs.restoreFromTrash
PUT/api/v1/docs/{id}/star
Stars or unstars a Docs space for the caller.
docs.starSpace
GET/api/v1/docs/{spaceId}/members
Lists the members of a Docs space.
docs.getMembers
POST/api/v1/docs/{spaceId}/members
Adds a person, group or agent to a Docs space with a role.
docs.addMember
PUT/api/v1/docs/{spaceId}/members/{memberId}
Changes the role of a member of a Docs space.
docs.updateMember
DELETE/api/v1/docs/{spaceId}/members/{memberId}
Removes a member from a Docs space.
docs.removeMember
GET/api/v1/docs/{spaceId}/people
Gets a short preview of who can open a Docs space, with the total count.
docs.getPeople
GET/api/v1/docs/for-user/{userId}
Lists the Docs spaces a workspace member belongs to that the caller can also open.
docs.getSpacesForUser
GET/api/v1/docs/spaces/archived
Lists the archived Docs spaces the caller administers.
docs.getArchivedList
GET/api/v1/docs/spaces/recent
Lists the Docs spaces the caller opened most recently.
docs.getRecentSpaces
GET/api/v1/docs/spaces/trash
Lists the Docs spaces in Trash that the caller administers.
docs.getTrashList

Request bodies:

  • CreateSpaceDto (create): requires title (string).
  • UpdateSpaceDto (update): requires title (string).
  • UpdateSpaceMemberDto (updateMember): no field is required.

Docs pages

POST/api/v1/docs/{spaceId}/pages
Creates a page in a Docs space, at the top level or under a parent page.
docs.createPage
POST/api/v1/docs/{spaceId}/pages/reorder
Sets the order of the pages under one parent in a Docs space.
docs.reorderPages
GET/api/v1/docs/{spaceId}/pages/tree
Gets the page tree of a Docs space, with the pages the caller can open.
docs.getTree
GET/api/v1/docs/pages/{id}
Gets a Docs page with its content.
docs.getPage
PUT/api/v1/docs/pages/{id}
Replaces the content of a Docs page.
docs.updatePage
DELETE/api/v1/docs/pages/{id}
Moves a Docs page and every page under it to Trash.
docs.deletePage
POST/api/v1/docs/pages/{id}/convert-to-rich
Converts a Markdown Docs page to a rich page.
docs.convertPageToRich
POST/api/v1/docs/pages/{id}/copy
Copies a Docs page, with the pages under it, to another place or space.
docs.copyPage
POST/api/v1/docs/pages/{id}/duplicate
Makes a copy of a Docs page beside it.
docs.duplicatePage
POST/api/v1/docs/pages/{id}/move
Moves a Docs page, with the pages under it, to another place or space.
docs.movePage
DELETE/api/v1/docs/pages/{id}/permanent
Permanently deletes a Docs page in Trash.
docs.deletePagePermanently
POST/api/v1/docs/pages/{id}/restore
Restores a Docs page from Trash.
docs.restorePage
PUT/api/v1/docs/pages/{id}/star
Stars or unstars a Docs page for the caller.
docs.starPage
PUT/api/v1/docs/pages/{id}/title
Renames a Docs page.
docs.renamePage
GET/api/v1/docs/pages/{pageId}/backlinks
Lists the Docs pages that link to a page.
docs.getBacklinks
GET/api/v1/docs/pages/{pageId}/members
Lists the people who can open a Docs page with restricted access.
docs.getPageMembers
POST/api/v1/docs/pages/{pageId}/members
Gives a person, group or agent a role on a Docs page with restricted access.
docs.addPageMember
DELETE/api/v1/docs/pages/{pageId}/members/{memberId}
Removes a member from a Docs page with restricted access.
docs.removePageMember
GET/api/v1/docs/pages/{pageId}/revisions
Lists the saved revisions of a Docs page, newest first.
docs.getRevisions
GET/api/v1/docs/pages/{pageId}/revisions/{revisionId}
Gets one saved revision of a Docs page with its content.
docs.getRevision
POST/api/v1/docs/pages/{pageId}/revisions/{revisionId}/restore
Restores a Docs page to one of its saved revisions.
docs.restoreRevision
POST/api/v1/docs/pages/{pageId}/visibility/reset
Removes a Docs page's own access list so it follows its space again.
docs.resetPageVisibility
GET/api/v1/docs/pages/recent
Lists the Docs pages the caller most recently viewed, edited or created.
docs.getRecentPages
GET/api/v1/docs/pages/search
Searches the Docs pages the caller can open, in every space or in one.
docs.searchPages
GET/api/v1/docs/pages/starred
Lists the Docs pages the caller has starred, paged.
docs.getStarredPages
GET/api/v1/docs/pages/trash
Lists the Docs pages in Trash that the caller can restore, paged.
docs.getTrashedPages

Request bodies:

  • CreatePageDto (createPage): requires title (string).
  • UpdatePageDto (updatePage): requires title (string).

Example

docs.getList: lists the Docs spaces the caller can open.

curl
curl -s "https://volobox.example.com/api/v1/docs" \
  -H "Authorization: Bearer $VOLOBOX_TOKEN"