ANanzworldline-solutions
Folders

Search folders

Changed on

Returns folders within a site matching an optional name filter and/or path scope. Supports recursive depth control, standard pagination, and sorting. With no 'name' and default path '/' + recursive=true, all site folders are returned. Each folder carries the detail fields a folder-edit form needs (title, sortOrder, filesMasks, defaultFileType, showOnMenu, defaultBaseType). Set 'includePermissions=true' to also receive the permission types the requesting user holds on each folder; that flag caps 'perPage' (see the parameter description).

get/api/v1/folder/search

Request

Query parameters

namestring

Optional case-insensitive partial match on folder name (minimum 2 characters when provided)

pathstring

Path scope for the search. Defaults to '/' (site root).

recursiveboolean

false = direct children of 'path' only (default); true = search all descendants

siteIdstring

Site ID to scope the search (required)

orderby'name' | 'mod_date'

Column to sort by.

direction'ASC' | 'DESC'

Sort direction

pageinteger

Page number (1-based, default 1)

per_pageinteger

Number of results per page (default 40)

includePermissionsboolean

When true, each returned folder includes a 'permissions' array with the permission types the requesting user holds on it (READ, EDIT, PUBLISH, EDIT_PERMISSIONS, CAN_ADD_CHILDREN). When false (the default) 'permissions' is null — meaning 'not requested', which is not the same as an empty array ('requested, no grants'). Because permissions are resolved per page, enabling this flag caps 'perPage' at the value of the 'content.drive.folder.search.permissions.max.per.page' configuration property (default 200); a larger 'perPage' is rejected with a 400.

Response

Paginated list of matching folders

i18nMessagesMapobject
permissionsstring[]

Changes