searchFolders( )


Retrieves a list of up to 200 folders with the specified filtering, sorting, and cursor paging.

If no parameters are specified, the method returns all folders in the MEDIA_ROOT folder.

Defaults

Search Folders has the following default setting, which you can override:

  • Sorted by updatedDate in descending order.

Filters

When using filters for dates, you must use UTC time.

See also

To learn about working with Search methods, see API Query Language (SDK | REST) and Sorting and Paging (SDK | REST).

Method Declaration
Copy
Method Parameters
optionsSearchFoldersOptions

Options specifying which folders to search.

Returns
Return Type:Promise<SearchFoldersResponse>
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?