Wiki

The project knowledge base — spaces, the page tree, version history, edit locks, comments, attachments, full-text search and the trash.

The wiki is the project's internal knowledge base. It is organised into spaces, and each space holds a tree of pages. Every save that changes a page's title or content creates a new version. Deleted pages go to the trash and can be restored together with their sub-pages.

Two people editing the same page are coordinated by an edit lock: a short-lived claim that an editor renews while the page is open. The lock is advisory. Saving does not check it, so a client that edits pages should acquire it first.

Field types follow the field notation.

Access

Every endpoint on this page requires both the projects and wiki OAuth scopes. The user must be a member of the project, and the owner's subscription must be active. Otherwise the endpoint returns 404 RES_NOT_FOUND. The project owner bypasses permission checks.

Space Object

Space Structure

List Spaces

GET /api/v1/projects/{project.uuid}/wiki/spaces

Returns the project's spaces, sorted by name. Requires can_view_wiki.

Get Space

GET /api/v1/projects/{project.uuid}/wiki/spaces/{space.uuid}

Requires can_view_wiki.

Create Space

POST /api/v1/projects/{project.uuid}/wiki/spaces

201 Created with {"uuid": "..."}. Requires can_edit_wiki.

Modify Space

PATCH /api/v1/projects/{project.uuid}/wiki/spaces/{space.uuid}

Updates any of name, description, owner_uuid (a project member). At least one must be present. PUT requires all three. An owner_uuid that is not a member fails with 400 RES_NOT_FOUND. 204 No Content. Requires can_edit_wiki.

Delete Space

DELETE /api/v1/projects/{project.uuid}/wiki/spaces/{space.uuid}

Deletes the space and moves all its pages to the trash. A deleted space cannot be restored through the API, and its pages no longer appear in the trash or in search. 204 No Content. Requires can_edit_wiki.

Page Object

Page Structure

Example Page

{
  "uuid": "0199ad49-6071-7283-9405-a6b7c8d9e0f1",
  "space_uuid": "0199ad40-0000-7000-8000-000000000001",
  "parent_uuid": "0199ad48-0000-7000-8000-000000000001",
  "title": "Cutting fabric",
  "slug": "cutting-fabric",
  "content": "## Allowances\n\nAdd 200 mm to the height for the roll.",
  "position": 0,
  "author_uuid": "0198e7aa-91f0-7c22-a4d1-0f9e8d7c6b5a",
  "updated_by_uuid": "0198e7aa-91f0-7c22-a4d1-0f9e8d7c6b5a",
  "breadcrumbs": [
    {
      "uuid": "0199ad48-0000-7000-8000-000000000001",
      "title": "Production"
    },
    {
      "uuid": "0199ad49-6071-7283-9405-a6b7c8d9e0f1",
      "title": "Cutting fabric"
    }
  ],
  "created_at": "2026-09-02T10:00:00.000Z",
  "updated_at": "2026-09-15T13:20:00.000Z"
}

List Space Pages

GET /api/v1/projects/{project.uuid}/wiki/spaces/{space.uuid}/pages

Returns every page of the space as a flat list, without content, sorted by position then title. Build the tree from parent_uuid. Requires can_view_wiki.

Get Page

GET /api/v1/projects/{project.uuid}/wiki/pages/{page.uuid}

Returns the full page with content and breadcrumbs. Requires can_view_wiki.

Create Page

POST /api/v1/projects/{project.uuid}/wiki/spaces/{space.uuid}/pages

Creates a page and its first version. Requires can_edit_wiki.

JSON Params

Response

201 Created with {"uuid": "..."}.

Modify Page

PATCH /api/v1/projects/{project.uuid}/wiki/pages/{page.uuid}

Updates any of title, content, parent_uuid, position. At least one must be present. A new version is created only if the title or content actually changed. A new parent must be in the same space and cannot be the page itself or one of its descendants.

Acquire the edit lock before saving.

PUT on the same path requires all four fields; parent_uuid may be null.

204 No Content. Requires can_edit_wiki.

Move Page

POST /api/v1/projects/{project.uuid}/wiki/pages/{page.uuid}/move

Moves a page within its space. Its sub-pages move with it. Does not create a version.

Positions of other pages are not shifted; send explicit positions for every sibling you reorder.

204 No Content. Requires can_edit_wiki.

Delete Page

DELETE /api/v1/projects/{project.uuid}/wiki/pages/{page.uuid}

Moves the page and all its sub-pages to the trash. 204 No Content. Requires can_edit_wiki.

Trash

List Trash

GET /api/v1/projects/{project.uuid}/wiki/trash

Returns the pages deleted directly, newest first. Their sub-pages are in the trash too, but are not listed: they come back with their parent. Pages of deleted spaces are not included. Requires can_view_wiki.

[
  {
    "uuid": "0199ad49-6071-7283-9405-a6b7c8d9e0f1",
    "title": "Cutting fabric",
    "space_uuid": "0199ad40-0000-7000-8000-000000000001",
    "space_name": "Production",
    "deleted_at": "2026-09-30T08:00:00.000Z",
    "deleted_by_name": "Anna Petrova"
  }
]

Restore Page

POST /api/v1/projects/{project.uuid}/wiki/pages/{page.uuid}/restore

Restores a page from the trash together with its deleted sub-pages. If its parent is still deleted, the page is restored to the top level of the space. Requires can_edit_wiki.

200 OK with the restored page uuids:

{
  "restored": [
    "0199ad49-6071-7283-9405-a6b7c8d9e0f1",
    "0199ad4a-0000-7000-8000-000000000002"
  ]
}

Versions

Version Structure

List Page Versions

GET /api/v1/projects/{project.uuid}/wiki/pages/{page.uuid}/versions

Returns versions newest first, without content. Requires can_view_wiki.

Get Page Version

GET /api/v1/projects/{project.uuid}/wiki/pages/{page.uuid}/versions/{version_number}

Requires can_view_wiki.

Restore Page Version

POST /api/v1/projects/{project.uuid}/wiki/pages/{page.uuid}/versions/{version_number}/restore

Sets the page's title and content to those of the version. History is not rewritten: this saves a new version with that content. Requires can_edit_wiki.

200 OK:

{
  "version_number": 8
}

Edit Lock

A lock lasts 45 seconds. An editor should acquire it when opening a page for editing, renew it more often than every 45 seconds while editing, and release it when done. A lock that is not renewed expires on its own.

Acquire Edit Lock

POST /api/v1/projects/{project.uuid}/wiki/pages/{page.uuid}/lock

Acquires the lock, or renews it if the user already holds it. Requires can_edit_wiki.

200 OK:

{
  "expires_in": 45000
}

expires_in is in milliseconds. If another user holds the lock, the response is 409 WIKI_PAGE_LOCKED with the holder:

{
  "id": 5003,
  "code": "WIKI_PAGE_LOCKED",
  "message": "This wiki page is currently being edited by another user.",
  "holder": {
    "user_uuid": "0198f0b2-3c4d-7e5f-8a6b-7c8d9e0f1a2b",
    "user_name": "Ivan Sidorov",
    "acquired_at": 1790871200000
  }
}

acquired_at is a Unix timestamp in milliseconds.

Release Edit Lock

DELETE /api/v1/projects/{project.uuid}/wiki/pages/{page.uuid}/lock

Releases the lock if the user holds it; otherwise does nothing. 204 No Content. Requires can_edit_wiki.

Comments

Comment Structure

List Page Comments

GET /api/v1/projects/{project.uuid}/wiki/pages/{page.uuid}/comments

Returns comments oldest first. Requires can_view_wiki and can_view_wiki_comment.

Create Page Comment

POST /api/v1/projects/{project.uuid}/wiki/pages/{page.uuid}/comments

201 Created with {"uuid": "..."}. Requires can_view_wiki and can_edit_wiki_comment.

Delete Page Comment

DELETE /api/v1/projects/{project.uuid}/wiki/pages/{page.uuid}/comments/{comment.uuid}

Deletes the user's own comment. 204 No Content.

Attachments

Files attached to a page. Upload the file first with Upload File into this project, then attach it.

Attachment Structure

List Page Attachments

GET /api/v1/projects/{project.uuid}/wiki/pages/{page.uuid}/files

Returns attachments, newest first. Requires can_view_wiki.

Attach File

POST /api/v1/projects/{project.uuid}/wiki/pages/{page.uuid}/files

201 Created with the attachment. Attaching the same file twice is not an error. Requires can_edit_wiki.

Detach File

DELETE /api/v1/projects/{project.uuid}/wiki/pages/{page.uuid}/files/{file.uuid}

Removes the attachment. The file itself is not deleted. 204 No Content. Requires can_edit_wiki.

Search Wiki

GET /api/v1/projects/{project.uuid}/wiki/search?q={query}

Full-text search across all pages of the project, up to 20 results, best match first. Pages in the trash and in deleted spaces are excluded. An empty q returns []. Requires can_view_wiki.

[
  {
    "uuid": "0199ad49-6071-7283-9405-a6b7c8d9e0f1",
    "title": "Cutting fabric",
    "space_uuid": "0199ad40-0000-7000-8000-000000000001",
    "space_name": "Production",
    "snippet": "Add 200 mm to the height for the \u0001roll\u0002.",
    "rank": 0.0607927
  }
]

snippet is plain text from the page with each match wrapped in the control characters U+0001 (start) and U+0002 (end). Split on them to highlight matches; do not render the snippet as HTML.

Errors