Sign in

v2

latestOpenAPI 3.1.02026-08-05313314398.1 KB
file-folders

List File Folders

List FileFolders. Default = direct children of parent_folder_id.

The flat-list mode is preserved for clients that haven't been migrated to nested navigation yet (the current frontend on main consumes a flat list); they pass flat=true and get every folder back.

get/api/v1/file-folders

Query parameters

parent_folder_idstring uuid nullable

If provided, return only direct children of this folder. Use the special value 'root' (encoded as missing) to list root folders.

If provided, return only direct children of this folder. Use the special value 'root' (encoded as missing) to list root folders.

flatboolean

If true, return every folder in the company (legacy flat view). When false (default) the response is scoped to direct children of parent_folder_id (or the root level if omitted).

If true, return every folder in the company (legacy flat view). When false (default) the response is scoped to direct children of parent_folder_id (or the root level if omitted).

Response

Successful Response

idstring required
namestring required
parent_folder_idstring nullable
merge_enabledboolean required
schema_modestring required
merge_database_idstring nullable required
write_semanticsstring
coverage_columnsstring[] nullable
coverage_granularitystring
batch_key_patternstring nullable
batch_sizeinteger nullable
batch_timeout_hoursnumber nullable
sealed_batch_keystring nullable
member_countinteger
has_childrenboolean