API: Searching files and folders
| Target URL | /api.php/Drive/files/search |
| Required scope | list |
| HTTP Method | POST |
| Output format | JSON |
Request Parameters Reference
| Parameter | Type | Required | Description |
|---|---|---|---|
| path | string | Yes | The FileRun path of the folder to search in. See this page |
| filename | string | No | Keyword to search in the file and folder names. |
| metatype | integer | No | ID of metadata file type. Get this from the FileRun control panel. |
| meta | array | No | The keys are metadata fields IDs, you can find them in FileRun's control panel. The key can also be any of the following strings: tag, rating, color, comment, or the character - for searching any field. The values are array of keywords to be searched for. |
| contents | string | No | Keyword to search files contents. Cannot be combined with any other search criteria. |
| details | array | No | Same as here. |
| limit | integer | No | The maximum number of items to return. 0, the default, returns all of them. |
| start | integer | No | The number of items to skip, for paging. |
The response has the same shape as the one of the listing endpoint: data.meta describes the searched folder and data.files holds the matching items.
For additional details please see this page.