Search

search

scope: files.metadata.read

Searches for files and folders. Note: search:2 along with search/continue:2 can only be used to retrieve a maximum of 10,000 matches. Recent changes may not immediately be reflected in search results due to a short delay in indexing. Duplicate results may be returned across pages. Some results may not be returned.

Basic Parameters

Parameter	Description
Include Highlights	Whether to include highlight span from file title. The default for this field is False.
Query	The string to search for. May match across multiple fields based on the request arguments.

Advanced Parameters

Parameter	Description
Account ID	Restricts results to the given account ID. This field is optional.
File Categories	Restricts search to only the file categories specified. Only supported for active file search. This field is optional.
File Extensions	Restricts search to only the extensions specified. Only supported for active file search. This field is optional.
File Status	Restricts search to the given file status. The default for this union is active.
Filename Only	Restricts search to only match on filenames. The default for this field is False.
Max Results	The maximum number of search results to return. The default for this field is 100.
Order By	Specified property of the order of search results. By default, results are sorted by relevance. This field is optional.
Path	Scopes the search to a path in the user's Dropbox. Searches the entire Dropbox if not specified. This field is optional.

Example Output

{
    "value": {
        "has_more": false,
        "matches": [
            {
                "metadata": {
                    ".tag": "metadata",
                    "metadata": {
                        ".tag": "file",
                        "client_modified": "2015-05-12T15:50:38Z",
                        "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
                        "file_lock_info": {
                            "created": "2015-05-12T15:50:38Z",
                            "is_lockholder": true,
                            "lockholder_name": "Imaginary User"
                        },
                        "has_explicit_shared_members": false,
                        "id": "id:a4ayc_80_OEAAAAAAAAAXw",
                        "is_downloadable": true,
                        "name": "Prime_Numbers.txt",
                        "path_display": "/Homework/math/Prime_Numbers.txt",
                        "path_lower": "/homework/math/prime_numbers.txt",
                        "property_groups": [
                            {
                                "fields": [
                                    {
                                        "name": "Security Policy",
                                        "value": "Confidential"
                                    }
                                ],
                                "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa"
                            }
                        ],
                        "rev": "a1c10ce0dd78",
                        "server_modified": "2015-05-12T15:50:38Z",
                        "sharing_info": {
                            "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
                            "parent_shared_folder_id": "84528192421",
                            "read_only": true
                        },
                        "size": 7212
                    }
                }
            }
        ]
    }
}

Workflow Library Example

Search with Dropbox and Send Results Via Email

Preview this Workflow on desktop