searchFiles( )

Searches all folders in the Media Manager and returns a list of files that match the terms specified in the parameters.

If no parameters are specified, the endpoint returns all files in the MEDIA_ROOT folder.

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 Bookings Services and Settings
Manage Media Manager
Read Media Manager
Manage Events
Access Verticals by Automations
Set Up Automations
Manage Portfolio
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
function searchFiles(options: SearchFilesOptions): Promise<SearchFilesResponse>;
Method Parameters
optionsSearchFilesOptions

Options to specify which folders to search.

Returns
Return Type:Promise<SearchFilesResponse>
JavaScript
import { files } from "@wix/media";

async function searchFiles(options) {
  const response = await files.searchFiles(options);
}
Errors
400Invalid Argument

There are 2 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?