Function API only Updated 17 Oct 2026

`getFileShares(path)`

Returns the active shares for a specific file.

Parameters

pathstringrequired

Absolute path of file to get shares for.

Returns

An object describing the file's sharing, as seen by the user who published the site: Name, User (owner's email), Owner, AllowInvite, AllowPublish, Direct, MyAccess and Shares — a list with User (email), AllowRead, AllowModify, AllowVisit, Accepted, Inherited and Since, including shares inherited from the folders above.

Shares is only filled in when the publisher may invite others to the file. null when the path is empty or the file does not exist.

Example

Normal JavaScript, running in the browser or on the Docly™ server.

let info = docly.getFileShares("myfile1");
return info;