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).

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Blog
Manage Bookings Services and Settings
Manage Challenges
Access Verticals by Automations
Set Up Automations
Manage Media Manager
Read Media Manager
Manage Events
Manage Portfolio
View SEO Settings
Manage Restaurants - all permissions
Manage Stores
Learn more about app permissions.
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?