> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.dropboxapi.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.dropboxapi.com/_mcp/server. # Properties Search POST https://api.dropboxapi.com/2/file_properties/properties/search Content-Type: application/json Search across property templates for particular property field values. **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) This endpoint does not support apps with the app folder permission. Reference: https://docs.dropboxapi.com/dropbox-api/api-reference/user-endpoints/file-properties/properties-search ## Authentication - `Authorization` header (bearer token, required) — OAuth 2.0 token issued to a specific user. Use `Authorization: Bearer `. 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). ## Request ### Headers - `Dropbox-API-Select-User` (string, optional) — Acts on behalf of a team member for supported user-auth operations. Pass a team member ID such as `dbmid:...`. When used with a team token, that token must also include the `team_data.member` scope. - `Dropbox-API-Path-Root` (string, optional) — Scopes path-based operations to a namespace (root). The value is a JSON serialization of the `common.PathRoot` union: `{".tag": "home"}`, `{".tag": "root", "root": ""}`, or `{".tag": "namespace_id", "namespace_id": ""}`. On failure the request returns 422 with a `common.PathRootError`. ### Body (application/json) This endpoint expects an object. - `queries` (list of object, required) — Queries to search. - `mode` (object, required) — The mode with which to perform the search. - file_properties.PropertiesSearchMode.field_name - `.tag` (enum, required) - Allowed values: `field_name` - `field_name` (string, required) - `query` (string, required) — The property field value for which to search across templates. - `logical_operator` (object, optional, nullable) — The logical operator with which to append the query. - file_properties.LogicalOperator.or_operator - `.tag` (enum, required) - Allowed values: `or_operator` - `template_filter` (object or object, optional, nullable) — Filter results to contain only properties associated with these template IDs. - file_properties.TemplateFilter.filter_some - `.tag` (enum, required) - Allowed values: `filter_some` - `filter_some` (list of string, required) - file_properties.TemplateFilter.filter_none - `.tag` (enum, required) - Allowed values: `filter_none` ## Response ### 200 Successful response - `matches` (list of object, required) — A list (possibly empty) of matches for the query. - `id` (string, required) — The ID for the matched file or folder. - `is_deleted` (boolean, required) — Whether the file or folder is deleted. - `path` (string, required) — The path for the matched file or folder. - `property_groups` (list of object, required) — List of custom property groups associated with the file. - `fields` (list of object, required) — The actual properties associated with the template. There can be up to 32 property types per template. - `name` (string, required) — Key of the property field associated with a file and template. Keys can be up to 256 bytes. - `value` (string, required) — Value of the property field associated with a file and template. Values can be up to 1024 bytes. - `template_id` (string, required) — A unique identifier for the associated template. - `cursor` (string, optional, nullable) — Pass the cursor into [properties/search/continue](api:dropbox-api:POST/2/file_properties/properties/search/continue) to continue to receive search results. Cursor will be null when there are no more results. ## Errors ### 401 Unauthorized Error Bad or expired token - `error` (object or object or object or object or object or object or object or object, required) — Errors occurred during authentication. - auth_apiv2.AuthError.invalid_access_token - `.tag` (enum, required) - Allowed values: `invalid_access_token` - auth_apiv2.AuthError.invalid_select_user - `.tag` (enum, required) - Allowed values: `invalid_select_user` - auth_apiv2.AuthError.invalid_select_admin - `.tag` (enum, required) - Allowed values: `invalid_select_admin` - auth_apiv2.AuthError.user_suspended - `.tag` (enum, required) - Allowed values: `user_suspended` - auth_apiv2.AuthError.expired_access_token - `.tag` (enum, required) - Allowed values: `expired_access_token` - auth_apiv2.AuthError.missing_scope - `.tag` (enum, required) - Allowed values: `missing_scope` - `required_scope` (string, required) — The required scope to access the route. - auth_apiv2.AuthError.route_access_denied - `.tag` (enum, required) - Allowed values: `route_access_denied` - Other - `.tag` (string, optional) - `error_summary` (string, required) — A human-readable summary of the error. ### 403 Forbidden Error The user or team account doesn't have access to the endpoint or feature - `error` (object or object or object or object or object, required) — Error occurred because the account doesn't have permission to access the resource. - auth_apiv2.AccessError.invalid_account_type - `.tag` (enum, required) - Allowed values: `invalid_account_type` - `invalid_account_type` (object or object or object, required) - auth_apiv2.InvalidAccountTypeError.endpoint - `.tag` (enum, required) - Allowed values: `endpoint` - auth_apiv2.InvalidAccountTypeError.feature - `.tag` (enum, required) - Allowed values: `feature` - Other - `.tag` (string, optional) - auth_apiv2.AccessError.paper_access_denied - `.tag` (enum, required) - Allowed values: `paper_access_denied` - `paper_access_denied` (object or object or object, required) - auth_apiv2.PaperAccessError.paper_disabled - `.tag` (enum, required) - Allowed values: `paper_disabled` - auth_apiv2.PaperAccessError.not_paper_user - `.tag` (enum, required) - Allowed values: `not_paper_user` - Other - `.tag` (string, optional) - auth_apiv2.AccessError.team_access_denied - `.tag` (enum, required) - Allowed values: `team_access_denied` - auth_apiv2.AccessError.no_permission - `.tag` (enum, required) - Allowed values: `no_permission` - `no_permission` (object or object, required) - auth_apiv2.NoPermissionError.unauthorized_account_id_usage - `.tag` (enum, required) - Allowed values: `unauthorized_account_id_usage` - `unauthorized_account_ids` (list of string, required) — The account IDs that the caller does not have permission to use. - Other - `.tag` (string, optional) - Other - `.tag` (string, optional) - `error_summary` (string, required) — A human-readable summary of the error. ### 409 Conflict Error Endpoint-specific error - `error` (object or object, required) - file_properties.PropertiesSearchError.property_group_lookup - `.tag` (enum, required) - Allowed values: `property_group_lookup` - `property_group_lookup` (object or object, required) - file_properties.LookUpPropertiesError.property_group_not_found - `.tag` (enum, required) - Allowed values: `property_group_not_found` - Other - `.tag` (string, optional) - Other - `.tag` (string, optional) - `error_summary` (string, required) — A human-readable summary of the error. - `user_message` (object, optional) - `locale` (string, optional) - `text` (string, optional) ### 429 Too Many Requests Error The app is making too many requests for the given user or team and is being rate limited. The app should wait for the number of seconds specified in the "Retry-After" response header before trying again. - `error` (object, required) — Error occurred because the app is being rate limited. - `reason` (object or object or object, required) — The reason why the app is being rate limited. - auth_apiv2.RateLimitReason.too_many_requests - `.tag` (enum, required) - Allowed values: `too_many_requests` - auth_apiv2.RateLimitReason.too_many_write_operations - `.tag` (enum, required) - Allowed values: `too_many_write_operations` - Other - `.tag` (string, optional) - `retry_after` (uint64, optional, default: 1) — The number of seconds that the app should wait before making another request. - `error_summary` (string, required) — A human-readable summary of the error. ### 500 Internal Server Error Internal server error. An error occurred on the Dropbox servers. Check https://status.dropbox.com/ for announcements about Dropbox service issues. - `any` ## Examples **Request** ```json { "queries": [ { "mode": { ".tag": "field_name", "field_name": "Security" }, "query": "Confidential", "logical_operator": { ".tag": "or_operator", "or_operator": null } } ], "template_filter": { ".tag": "filter_none", "filter_none": null } } ``` **Response** ```json { "matches": [ { "id": "id:a4ayc_80_OEAAAAAAAAAXz", "is_deleted": false, "path": "/my_awesome/word.docx", "property_groups": [ { "fields": [ { "name": "Security Policy", "value": "Confidential" } ], "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" } ] } ] } ``` **SDK Code** ```python import requests url = "https://api.dropboxapi.com/2/file_properties/properties/search" payload = { "queries": [ { "mode": { ".tag": "field_name", "field_name": "Security" }, "query": "Confidential", "logical_operator": { ".tag": "or_operator", "or_operator": None } } ], "template_filter": { ".tag": "filter_none", "filter_none": None } } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.dropboxapi.com/2/file_properties/properties/search'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"queries":[{"mode":{".tag":"field_name","field_name":"Security"},"query":"Confidential","logical_operator":{".tag":"or_operator","or_operator":null}}],"template_filter":{".tag":"filter_none","filter_none":null}}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.dropboxapi.com/2/file_properties/properties/search" payload := strings.NewReader("{\n \"queries\": [\n {\n \"mode\": {\n \".tag\": \"field_name\",\n \"field_name\": \"Security\"\n },\n \"query\": \"Confidential\",\n \"logical_operator\": {\n \".tag\": \"or_operator\",\n \"or_operator\": null\n }\n }\n ],\n \"template_filter\": {\n \".tag\": \"filter_none\",\n \"filter_none\": null\n }\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.dropboxapi.com/2/file_properties/properties/search") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"queries\": [\n {\n \"mode\": {\n \".tag\": \"field_name\",\n \"field_name\": \"Security\"\n },\n \"query\": \"Confidential\",\n \"logical_operator\": {\n \".tag\": \"or_operator\",\n \"or_operator\": null\n }\n }\n ],\n \"template_filter\": {\n \".tag\": \"filter_none\",\n \"filter_none\": null\n }\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.dropboxapi.com/2/file_properties/properties/search") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"queries\": [\n {\n \"mode\": {\n \".tag\": \"field_name\",\n \"field_name\": \"Security\"\n },\n \"query\": \"Confidential\",\n \"logical_operator\": {\n \".tag\": \"or_operator\",\n \"or_operator\": null\n }\n }\n ],\n \"template_filter\": {\n \".tag\": \"filter_none\",\n \"filter_none\": null\n }\n}") .asString(); ``` ```php request('POST', 'https://api.dropboxapi.com/2/file_properties/properties/search', [ 'body' => '{ "queries": [ { "mode": { ".tag": "field_name", "field_name": "Security" }, "query": "Confidential", "logical_operator": { ".tag": "or_operator", "or_operator": null } } ], "template_filter": { ".tag": "filter_none", "filter_none": null } }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.dropboxapi.com/2/file_properties/properties/search"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"queries\": [\n {\n \"mode\": {\n \".tag\": \"field_name\",\n \"field_name\": \"Security\"\n },\n \"query\": \"Confidential\",\n \"logical_operator\": {\n \".tag\": \"or_operator\",\n \"or_operator\": null\n }\n }\n ],\n \"template_filter\": {\n \".tag\": \"filter_none\",\n \"filter_none\": null\n }\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "queries": [ [ "mode": [ ".tag": "field_name", "field_name": "Security" ], "query": "Confidential", "logical_operator": [ ".tag": "or_operator", "or_operator": ] ] ], "template_filter": [ ".tag": "filter_none", "filter_none": ] ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.dropboxapi.com/2/file_properties/properties/search")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```