Dropbox: Search across property templates for particular property field values

← File properties operations · Get started

Operation dropbox.file_properties_properties_search

Provider route: POST /2/file_properties/properties/search. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/dropbox with npm, or alter-sdk-dropbox with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DropboxIntegration } from "@alter-ai/dropbox";

async function execute(input: Parameters<DropboxIntegration["fileProperties"]["propertiesSearch"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new DropboxIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.fileProperties.propertiesSearch(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_dropbox import DropboxIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = DropboxIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.file_properties.properties_search(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
headers	object	Optional	Additional keys: not allowed
headers.Dropbox-API-Path-Root	Model	Optional	Expand Deletes a group — request body — headers Dropbox-API-Path-Root
headers.Dropbox-API-Select-User	string	Optional
headers.Dropbox-API-Select-Admin	string	Optional
body	Model	Required within parent	Expand Search across property templates for particular property field values — request body — body

Referenced models: Deletes a group — request body — headers Dropbox-API-Path-Root, Search across property templates for particular property field values — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Search across property templates for particular property field values — response body

Referenced models: Search across property templates for particular property field values — response body

Schemas

Deletes a group — request body — headers Dropbox-API-Path-Root

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	One of: home
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: home
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: root
$ (anyOf 3).root	string	Required within parent	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
$ (anyOf 4)	object	Alternative
$ (anyOf 4)..tag	string	Required within parent	Must equal: namespace_id
$ (anyOf 4).namespace_id	string	Required within parent	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
$ (anyOf 5)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 5)..tag	string	Required within parent	Pattern: ^(?!(?:home|root|namespace_id)$)

Search across property templates for particular property field values — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
queries	array	Required within parent	Minimum items: 1
queries[]	Model	Each item	Expand Search across property templates for particular property field values — request body — body queries item
template_filter	Model	Optional	Expand Search across property templates for particular property field values — request body — body template filter

Referenced models: Search across property templates for particular property field values — request body — body queries item, Search across property templates for particular property field values — request body — body template filter

Search across property templates for particular property field values — response body

Field	Type	Presence	Description and constraints
$	object	Root
matches	array	Required within parent
matches[]	Model	Each item	Expand Search across property templates for particular property field values — response body — matches item
cursor	JSON	Optional
cursor (anyOf 1)	string	Alternative	Minimum length: 1
cursor (anyOf 2)	null	Alternative

Referenced models: Search across property templates for particular property field values — response body — matches item

Search across property templates for particular property field values — request body — body queries item

Field	Type	Presence	Description and constraints
$	object	Root
query	string	Required within parent
mode	Model	Required within parent	Expand Search across property templates for particular property field values — request body — body queries item mode
logical_operator	Model	Optional	Expand Search across property templates for particular property field values — request body — body queries item logical operator

Referenced models: Search across property templates for particular property field values — request body — body queries item logical operator, Search across property templates for particular property field values — request body — body queries item mode

Search across property templates for particular property field values — request body — body template filter

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	One of: filter_none
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: filter_some
$ (anyOf 2).filter_some	array	Required within parent	Minimum items: 1
$ (anyOf 2).filter_some[]	string	Each item	Minimum length: 1 Pattern: ^(?:(/|ptid:).*)$
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: filter_none
$ (anyOf 4)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tag	string	Required within parent	Pattern: ^(?!(?:filter_some|filter_none)$)

Search across property templates for particular property field values — response body — matches item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Minimum length: 1
path	string	Required within parent
is_deleted	boolean	Required within parent
property_groups	array	Required within parent
property_groups[]	Model	Each item	Expand Add property groups to a Dropbox file — request body — body property groups item

Referenced models: Add property groups to a Dropbox file — request body — body property groups item

Search across property templates for particular property field values — request body — body queries item logical operator

Field	Type	Presence	Description and constraints
$	JSON	Root	Logical operator to join search queries together.
$ (anyOf 1)	string	Alternative	One of: or_operator
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: or_operator
$ (anyOf 3)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 3)..tag	string	Required within parent	Pattern: ^(?!(?:or_operator)$)

Search across property templates for particular property field values — request body — body queries item mode

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative
$ (anyOf 1)..tag	string	Required within parent	Must equal: field_name
$ (anyOf 1).field_name	string	Required within parent
$ (anyOf 2)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 2)..tag	string	Required within parent	Pattern: ^(?!(?:field_name)$)

Add property groups to a Dropbox file — request body — body property groups item

Field	Type	Presence	Description and constraints
$	object	Root	A subset of the property fields described by the corresponding PropertyGroupTemplate. Properties are always added to a Dropbox file as a PropertyGroup. The possible key names and value types in this group are defined by the corresponding PropertyGroupTemplate.
template_id	string	Required within parent	Minimum length: 1 Pattern: ^(?:(/|ptid:).*)$
fields	array	Required within parent
fields[]	Model	Each item	Expand Add property groups to a Dropbox file — request body — body property groups item fields item

Referenced models: Add property groups to a Dropbox file — request body — body property groups item fields item

Add property groups to a Dropbox file — request body — body property groups item fields item

Field	Type	Presence	Description and constraints
$	object	Root	Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a PropertyGroup.
name	string	Required within parent
value	string	Required within parent

Policy, approvals and errors

SDK function policy ID: dropbox.file_properties_properties_search. Catalog operation: file_properties/properties_search. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["files.metadata.read"]

Official provider source