Skip to content
Leadtime
English
EnglishDeutschNot translated
Esc
↑↓navigate↵open⌘Jpreview

Get a compact project documentation tree

Returns ordered folders and pages for one project. Page bodies are not included. Project and node capabilities come from the server.

GET/projects/documentation/tree
Authorization
AuthorizationOAuth2 access token · headerrequired
Scopes:api:read
or
AuthorizationBearer token (JWT) · headerrequired
Query parameters
projectIdstringrequired

Project UUID or short identifier, such as RHEIN-2.

Responses
200
capabilitiesProjectDocumentationProjectCapabilitiesDtorequired
Show properties
createFolderbooleanrequired
createPagebooleanrequired
manageGuestVisibilitybooleanrequired

True when the caller can change page and folder guest visibility. Internal documentation managers in Selected pages mode only.

nodesProjectDocumentationTreeNodeDto[]required
Show properties
Array of ProjectDocumentationTreeNodeDto
capabilitiesProjectDocumentationNodeCapabilitiesDtorequired
Show properties
createCheckpointbooleanrequired
deleteNodebooleanrequired
editContentbooleanrequired
editMetadatabooleanrequired
manageGuestVisibilitybooleanrequired

True when the caller can change this node guest visibility. Internal documentation managers in Selected pages mode only.

manageTagsbooleanrequired
moveNodebooleanrequired
readContentbooleanrequired
restoreCheckpointbooleanrequired
childrenProjectDocumentationTreeNodeDto[]required
Show properties
Array of ProjectDocumentationTreeNodeDto
Circular reference to ProjectDocumentationTreeNodeDto.
contentEtagstring | nullrequired

Unquoted SHA-256 content identity for a page, or null for a folder. Send a page value unchanged for an exact edit.

contentGenerationnumber | nullrequired
min 1
createdAtstring<date-time>required
descendantPageCountnumber
guestIndicatorstring

Selected-pages tree indicator for internal callers. Organization members do not receive this field.

Allowed:nonevisiblepartial
guestVisibleboolean

Direct guest-visibility flag. Present for internal callers. Organization members do not receive this field.

idstring<uuid>required
kindstringrequired
Allowed:FolderPage
lastEditorUserIdstring<uuid> | nullrequired
parentIdstring<uuid> | nullrequired
projectIdstring<uuid>required
sortnumberrequired
tagsstring<uuid>[]required

Current active documentation tag UUIDs. Folders always return an empty array.

titlestringrequired
updatedAtstring<date-time>required
userIdstring<uuid>required
visibleDescendantPageCountnumber
projectIdstringrequired
publicationobject

Publication summary for internal callers. Organization members do not receive this field.

Show properties
effectiveModestringrequired
Allowed:HiddenAllPagesSelectedPages
guestAccessEnabledbooleanrequired
organizationModestringrequired
Allowed:HiddenAllPagesSelectedPages
projectOverridestring | nullrequired
Allowed:HiddenAllPagesSelectedPages
sourcestringrequired
Allowed:projectorganization
totalPageCountnumberrequired
visiblePageCountnumberrequired
400

The projectId query parameter is missing or invalid.

errorstring | object

HTTP error name or a structured HTTP exception response.

Show properties
One of:
string
string
object
object
messagestring | string[] | objectrequired

Error message, validation message list, or request-field validation message map.

Show properties
One of:
string
string
string[]
Array of string
string
object
object
statusCodenumberrequired

HTTP status code for this response.

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

404

The project does not exist or is not accessible.

errorstring | object

HTTP error name or a structured HTTP exception response.

Show properties
One of:
string
string
object
object
messagestring | string[] | objectrequired

Error message, validation message list, or request-field validation message map.

Show properties
One of:
string
string
string[]
Array of string
string
object
object
statusCodenumberrequired

HTTP status code for this response.

Try it
Server
Authorization
Parameters
Request
curl -X GET "https://leadtime.app/api/public/projects/documentation/tree?projectId=RHEIN-2" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Response
{
  "capabilities": {
    "createFolder": true,
    "createPage": true,
    "manageGuestVisibility": true
  },
  "nodes": [
    {
      "capabilities": {
        "createCheckpoint": true,
        "deleteNode": true,
        "editContent": true,
        "editMetadata": true,
        "manageGuestVisibility": true,
        "manageTags": true,
        "moveNode": true,
        "readContent": true,
        "restoreCheckpoint": true
      },
      "children": [
        {}
      ],
      "contentEtag": "8e2ffa0587a5c9e89d3a5228fc2b6693b8941588d06a249dd7bfb6b7e8d871a1",
      "contentGeneration": 1,
      "createdAt": "2019-08-24T14:15:22Z",
      "descendantPageCount": 0,
      "guestIndicator": "none",
      "guestVisible": true,
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "kind": "Folder",
      "lastEditorUserId": "96c7d29e-b430-4bc0-a4a1-47f97dd1f5ed",
      "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
      "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
      "sort": 0,
      "tags": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "title": "string",
      "updatedAt": "2019-08-24T14:15:22Z",
      "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
      "visibleDescendantPageCount": 0
    }
  ],
  "projectId": "string",
  "publication": {
    "effectiveMode": "Hidden",
    "guestAccessEnabled": true,
    "organizationMode": "Hidden",
    "projectOverride": "Hidden",
    "source": "project",
    "totalPageCount": 0,
    "visiblePageCount": 0
  }
}