Document folders

Returns folders with how many documents each holds and how many folders sit inside it. Pass album_parent=root for the top level and a folder id to walk down, which is how the tree is drawn a level at a time rather than all at once. A smart folder carries the saved filter it resolves in album_query_search.

Requires the module-documents license feature. Without it the request is refused with 403 license_required — see plans and modules.

Creates a folder, which starts empty — put documents in it with POST /document-folders/{id}/files. Pass album_parent to nest it. A folder that fills itself from a saved filter is created through POST /document-folders/smart instead.

Requires the module-documents license feature. Without it the request is refused with 403 license_required — see plans and modules.

Returns the folder with its file and child counts, the path of folders above it, and — for a smart folder — the filter it resolves.

Requires the module-documents license feature. Without it the request is refused with 403 license_required — see plans and modules.

Removes the folder. The documents it held stay in the library, and folders inside it move to the top level.

Requires the module-documents license feature. Without it the request is refused with 403 license_required — see plans and modules.

Applies the album_-prefixed fields present in the body. Moving a folder under a new parent is a change to album_parent here; a move that would make a folder its own ancestor is refused. A smart folder's filter is changed through PATCH /document-folders/{id}/smart.

Requires the module-documents license feature. Without it the request is refused with 403 license_required — see plans and modules.

Puts documents in the folder. A document may sit in more than one. Ids that match no document in the library are skipped rather than failing the request, so a partly stale selection still lands.

Requires the module-documents license feature. Without it the request is refused with 403 license_required — see plans and modules.

Takes the documents out of the folder and leaves them in the library.

Requires the module-documents license feature. Without it the request is refused with 403 license_required — see plans and modules.

Replaces the saved filter a smart folder resolves. Membership is recomputed on read, so the change is visible immediately and no documents are moved.

Requires the module-documents license feature. Without it the request is refused with 403 license_required — see plans and modules.

Returns which documents sit in which folder, without the document records themselves.

Requires the module-documents license feature. Without it the request is refused with 403 license_required — see plans and modules.

A smart folder is a saved filter rather than a fixed list: its contents are whatever currently matches, so documents join and leave it on their own as the library changes.

Requires the module-documents license feature. Without it the request is refused with 403 license_required — see plans and modules.

How many folders the workspace has. For counts within one folder, read the folder itself — it carries its own document and child counts.

Requires the module-documents license feature. Without it the request is refused with 403 license_required — see plans and modules.