Search v2

POST

https://api.dropboxapi.com/2/files/search_v2

POST

/2/files/search_v2

import requests
url = "https://api.dropboxapi.com/2/files/search_v2"
payload = {
    "query": "cat",
    "match_field_options": { "include_highlights": False },
    "options": {
        "max_results": 20,
        "path": "/Folder"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "has_more": false,
  "matches": [
    {
      "metadata": {
        ".tag": "metadata",
        "metadata": {
          ".tag": "file",
          "client_modified": "2015-05-12T15:50:38Z",
          "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
          "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",
          "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
        }
      },
      "highlight_spans": null
    }
  ],
  "cursor": null
}

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.

Required scope: files.metadata.read

Endpoint format: RPC

Authentication: User

Searches for files and folders. Note: [search:2](api:dropbox-api:POST/2/files/search_v2) along with [search/continue:2](api:dropbox-api:POST/2/files/search/continue_v2) 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. **Required scope:** `files.metadata.read` **Endpoint format:** [RPC](https://docs.dropboxapi.com/dropbox-api/docs/technical-reference/request-response-formats#rpc-endpoints) **Authentication:** [User](https://docs.dropboxapi.com/dropbox-api/docs/auth-types#user-authentication)

Authentication

AuthorizationBearer

OAuth 2.0 token issued to a specific user. Use Authorization: Bearer <token>.

Public clients should use the authorization code flow with PKCE (S256).

For background or offline access, send token_access_type=offline during authorization and use the returned refresh token to obtain new access tokens.

You can generate a short-lived access token from the App Console; see Testing with a generated token.

OAuth 2.0 token issued to a specific user. Use `Authorization: Bearer <token>`. Public clients should use the authorization code flow with PKCE (S256). For background or offline access, send `token_access_type=offline` during authorization and use the returned refresh token to obtain new access tokens. You can generate a short-lived access token from the App Console; see [Testing with a generated token](https://docs.dropboxapi.com/dropbox-api/docs/oauth#testing-with-a-generated-token).

Headers

Dropbox-API-Path-RootstringOptional

Scopes path-based operations to a namespace (root). The value is a JSON serialization of the common.PathRoot union: {".tag": "home"}, {".tag": "root", "root": "<namespace_id>"}, or {".tag": "namespace_id", "namespace_id": "<namespace_id>"}. On failure the request returns 422 with a common.PathRootError.

Scopes path-based operations to a namespace (root). The value is a JSON serialization of the `common.PathRoot` union: `{".tag": "home"}`, `{".tag": "root", "root": "<namespace_id>"}`, or `{".tag": "namespace_id", "namespace_id": "<namespace_id>"}`. On failure the request returns 422 with a `common.PathRootError`.

Request

This endpoint expects an object.

querystringRequired<=1000 characters

The string to search for. May match across multiple fields based on the request arguments.

match_field_optionsobject or nullOptional

Options for search results match fields.

optionsobject or nullOptional

Options for more targeted search results.

include_highlightsboolean or nullOptionalDeprecated

Deprecated and moved this option to SearchMatchFieldOptions.

Response headers

X-Dropbox-Request-IdstringOptional

A unique identifier for the request, useful for debugging and support.

Response

Successful response

has_moreboolean

Used for paging. If true, indicates there is another page of results available that can be fetched by calling search/continue:2 with the cursor.

matcheslist of objects

A list (possibly empty) of matches for the query.

cursorstring or nullOptional>=1 character

Pass the cursor into search/continue:2 to fetch the next page of results.

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error