Docly Developers
Function Updated 17 Oct 2026

getFolder(path)

Returns information about a folder by given path.

See also getFolderProps getFiles folderExists Path traversal

Parameters

pathstringrequired

Path to the folder, from the site root.

Returns

An object with the folder's own properties (from its folder properties document) plus Name, DoclyId, Guid, LastModified, Created, Size and Path — and FormName when the properties document has a schema. null when the path is empty or the folder does not exist.

No access check is made. Properties in an encrypted folder can only be read after unlockFolder.

Example

Normal JavaScript, 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);