Login

getFolder(path) Last updated: 29. Apr 2026

Returns information about a folder by given path.

See also: getFolderProps getFiles folderExists

Parameters

Name Type Description
path string Absolute path to folder

Returns

Information about folder.

Example

Code example (JS)

JS is normal JavaScript either running in the browser or on the Docly™ server. 
/* Get the folder with getFolder */
let folder = docly.getFolder("/Test files");

/* Format the output */
var json = JSON.stringify(folder);

var formatted = docly.formatJson(json).replace("\r", "");
write(formatted);

Output

The JS code above produces the output shown below: 
{
  "DisplayName": "",
  "Description": "",
  "Hide": true,
  "Image": "",
  "SortOrder": 5,
  "DefaultContent": true,
  "Accept": "",
  "SpecifyCustomColumns": false,
  "CustomColumns": [],
  "CustomColumns_type": "CustomColumns",
  "OKCount": "0",
  "PassedCount": "0",
  "FailedCount": "0",
  "TotalCount": "0",
  "RemainCount": "0",
  "Name": "Test files",
  "DoclyId": 45971,
  "Guid": "C8d12d7JNk-kdRcdq0udaw",
  "LastModified": "2026-04-05T14:04:09.2233189+02:00",
  "Created": "2022-12-19T16:06:00.8759219+01:00",
  "Size": 7655,
  "Path": "/Test files",
  "FormName": "Published folder"
}