ATattention
Library

List Library Folder Structure

Retrieves the folder structure for the library. If folderUUID is provided, returns only the direct subfolders of that folder. If folderUUID is not provided, returns the root folder structure. This endpoint supports lazy loading of folder hierarchies for workflow builders.

get/library/folders

Request

Query parameters

userUUIDstring required

UUID of the user. Required to fetch folder structure.

folderUUIDstring

UUID of the folder to fetch subfolders from. If not provided, returns root folder structure. When provided, returns only direct subfolders of the specified folder.

myLibraryboolean

If true, returns only the user's personal library folders. If false, returns organization-level library folders.

includeHiddenboolean

If true, includes hidden folders in the response. Default is false.

Response

Folder structure successfully retrieved

Example response

{
  "data": {
    "uuid": "folder-uuid-root",
    "name": "Sales Library",
    "organizationUUID": "org-uuid-123",
    "parentUUID": "",
    "path": "/Sales Library",
    "hidden": false,
    "subFolders": [
      {
        "uuid": "folder-uuid-sub-1",
        "name": "Best Practices",
        "parentUUID": "folder-uuid-root",
        "hidden": false,
        "totalElements": 15,
        "totalFolders": 2
      }
    ],
    "subFoldersTotal": 3
  }
}

Changes

No recorded changes to this operation across all 4 revisions of this API.