Login

getFolders(path, [options]) Last updated: 26. Nov 2025

Gets a list of all subfolders below a specific folder.

Parameters

Name Type Description
path string Absolute path to the folder which you want to list sub folders for.
options (optional)objectSpecify any of the following options parameters:
• name string Enter a wildcard of files to retreive, default is "*"
• depth number How many extra levels of subfolders, default is 0
• recursive bool Get sub folders recursively, default false.
• properties bool Get with folder properties, default true.
Use false for faster execution without this extra information.
• filter object | function Filter items based on their properties. Accepts either:
1. Object with key-value pairs for exact matching (e.g. { "Status": "active", "Category": "docs" })
2. Function that receives each file and returns true/false (e.g. x => x.Filesize > 1000 && x.Extension == "pdf")
• fields csv | array | object Specify fields to retrieve via:
1. CSV string (e.g. "filename,Filesize")
2. Array of strings (e.g. ["filename","Filesize"])
3. Object map for renaming (e.g. {"newName":"filename"})

Returns

An array of folder objects.

Example

Code example (#JS)

#JS is mixed HTML (or other text file) with inline JavaScript with # starting and ending each inline statement. 
#{
    // Get the list of files
    var list = docly.getFolders("Test files");
    
    // The rest of the code just outputs the list in the demo field below
    var json = JSON.stringify(list);
    var formatted = docly.formatJson(json);
    var html = formatted.replace(chr(13), "");
    write(html);
}#

Output

The #JS code above produces the output shown below: 
[
  {
    "SortOrder": "1",
    "DefaultContent": true,
    "Accept": "",
    "SpecifyCustomColumns": false,
    "CustomColumns": [],
    "CustomColumns_type": "CustomColumns",
    "HideFilenameColumn": false,
    "Expand": true,
    "Packages": [],
    "Packages_type": "Packages",
    "ROWID": "4533b73f-c3b6-5e77-b143-222e43d122fb",
    "OKCount": "0",
    "PassedCount": "0",
    "FailedCount": "0",
    "TotalCount": "0",
    "RemainCount": "0",
    "Name": "Folder 1",
    "Url": "/Test-files/Folder-1",
    "DoclyId": 45972,
    "Guid": "3rujvHyLOE-BkiQUUX5Kng",
    "LastModified": "2025-01-30T11:16:35.500075+01:00",
    "Size": 582,
    "Path": "/Test files/Folder 1"
  },
  {
    "Name": "Folder 2",
    "Url": "/Test-files/Folder-2",
    "DoclyId": 45973,
    "Guid": "4KBt5OiHKUO_CMfMjN4rUA",
    "LastModified": "2025-01-30T11:15:36.4144002+01:00",
    "Size": 237,
    "Path": "/Test files/Folder 2"
  },
  {
    "Name": "Folder 3",
    "Url": "/Test-files/Folder-3",
    "DoclyId": 45974,
    "Guid": "rXOvQs861068dtNVyXh3nQ",
    "LastModified": "2025-01-30T11:15:41.7160163+01:00",
    "Size": 237,
    "Path": "/Test files/Folder 3"
  }
]