Properties Search

POST

https://api.dropboxapi.com/2/file_properties/properties/search

POST

/2/file_properties/properties/search

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 <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

Response headers

HTTP/1.1 200 OK
X-Dropbox-Request-Id: string

{
  "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"
        }
      ]
    }
  ]
}

Search across property templates for particular property field values.

Required scope: files.metadata.read

Endpoint format: RPC

Authentication: User

This endpoint does not support apps with the app folder permission.

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.

Headers

Request

This endpoint expects an object.

querieslist of objectsRequired

Queries to search.

template_filterobject or nullOptional

Filter results to contain only properties associated with these template IDs.

Variant:

file_properties.TemplateFilter.filter_someobjectRequired

Only templates with an ID in the supplied list will be returned (a subset of templates will be returned).

Response headers

X-Dropbox-Request-IdstringOptional

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

Response

Successful response

matcheslist of objects

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

cursorstring or nullOptional>=1 character

Pass the cursor into properties/search/continue to continue to receive search results. Cursor will be null when there are no more results.

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error