navigation

getFolderHierarchy

Get the folder and document tree. Pass folderId for the subtree under one folder, or projectId for the project's ENTIRE folder tree from the root (no need to reassemble listFolders' flat list by parentId). Alias for getProjectHierarchy.

post/tools/getFolderHierarchy

Request

  • Base URL: https://api.stablebaseline.io/functions/v1/cloud-serve/api/v1
  • URL: https://api.stablebaseline.io/functions/v1/cloud-serve/api/v1/tools/getFolderHierarchy
  • Auth: HTTP bearer

Request body

projectIdstring

Return the whole project's folder tree from the root. Provide this or folderId.

folderIdstring

The folder ID to start from. Omit and pass projectId to get the project root hierarchy.

maxDepthnumber

Max nesting depth. Default: 10, max: 20.

includeDocumentsboolean

Include documents. Default: true.

querystring

Filter by name/title (case-insensitive).

fromDatestring

ISO 8601 date filter (from).

toDatestring

ISO 8601 date filter (to).

dateFieldstring

Date field to filter. Default: updated_at.

Response

Tool result (shape varies per tool — refer to the tool's docs for the exact return value).

object required

Changes

No recorded changes to this operation across all 1 revision of this API.