Dropbox: Searches for files and folders

← Files operations · Get started

Operation dropbox.files_search_v2

Provider route: POST /2/files/search_v2. 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["files"]["searchV2"]>[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.files.searchV2(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.files.search_v2(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 Searches for files and folders — request body — body

Referenced models: Deletes a group — request body — headers Dropbox-API-Path-Root, Searches for files and folders — 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 Searches for files and folders — response body

Referenced models: Searches for files and folders — response body

Schemas

18 more schemas are linked from the tables above, on the schema pages.

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)$)

Searches for files and folders — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
query	string	Required within parent	Maximum length: 1000
options	JSON	Optional
options (anyOf 1)	Model	Alternative	Expand Searches for files and folders — request body — body options account id, file categories, file extensions, file status, filename only, max results, order by, path
options (anyOf 2)	null	Alternative
match_field_options	JSON	Optional
match_field_options (anyOf 1)	Model	Alternative	Expand Searches for files and folders — request body — body match field options include highlights
match_field_options (anyOf 2)	null	Alternative
include_highlights	JSON	Optional
include_highlights (anyOf 1)	boolean	Alternative
include_highlights (anyOf 2)	null	Alternative

Referenced models: Searches for files and folders — request body — body match field options include highlights, Searches for files and folders — request body — body options account id, file categories, file extensions, file status, filename only, max results, order by, path

Searches for files and folders — response body

Field	Type	Presence	Description and constraints
$	object	Root
matches	array	Required within parent
matches[]	Model	Each item	Expand Searches for files and folders — response body — matches item
has_more	boolean	Required within parent
cursor	JSON	Optional
cursor (anyOf 1)	string	Alternative	Minimum length: 1
cursor (anyOf 2)	null	Alternative

Referenced models: Searches for files and folders — response body — matches item

Searches for files and folders — request body — body match field options include highlights

Field	Type	Presence	Description and constraints
$	object	Root
include_highlights	boolean	Optional

Searches for files and folders — request body — body options account id, file categories, file extensions, file status, filename only, max results, order by, path

Field	Type	Presence	Description and constraints
$	object	Root
path	JSON	Optional
path (anyOf 1)	string	Alternative	Pattern: ^(?:(/(.|[\r\n])*)?|id:.*|(ns:[0-9]+(/(.|[\r\n])*)?))$
path (anyOf 2)	null	Alternative
max_results	integer	Optional	Minimum: 1 Maximum: 1000
order_by	JSON	Optional
order_by (anyOf 1)	Model	Alternative	Expand Searches for files and folders — request body — body options account id, file categories, file extensions, file status, filename only, max results, order by, path order by value
order_by (anyOf 2)	null	Alternative
file_status	Model	Optional	Expand Searches for files and folders — request body — body options account id, file categories, file extensions, file status, filename only, max results, order by, path file status
filename_only	boolean	Optional
file_extensions	JSON	Optional
file_extensions (anyOf 1)	array	Alternative
file_extensions (anyOf 1)[]	string	Each item
file_extensions (anyOf 2)	null	Alternative
file_categories	JSON	Optional
file_categories (anyOf 1)	array	Alternative
file_categories (anyOf 1)[]	Model	Each item	Expand Searches for files and folders — request body — body options account id, file categories, file extensions, file status, filename only, max results, order by, path file categories array item
file_categories (anyOf 2)	null	Alternative
account_id	JSON	Optional
account_id (anyOf 1)	string	Alternative	Maximum length: 40 Minimum length: 40
account_id (anyOf 2)	null	Alternative

Referenced models: Searches for files and folders — request body — body options account id, file categories, file extensions, file status, filename only, max results, order by, path file categories array item, Searches for files and folders — request body — body options account id, file categories, file extensions, file status, filename only, max results, order by, path file status, Searches for files and folders — request body — body options account id, file categories, file extensions, file status, filename only, max results, order by, path order by value

Searches for files and folders — response body — matches item

Field	Type	Presence	Description and constraints
$	object	Root
metadata	Model	Required within parent	Expand Searches for files and folders — response body — matches item metadata
match_type	JSON	Optional
match_type (anyOf 1)	Model	Alternative	Expand Searches for files and folders — response body — matches item match type value
match_type (anyOf 2)	null	Alternative
highlight_spans	JSON	Optional
highlight_spans (anyOf 1)	array	Alternative
highlight_spans (anyOf 1)[]	Model	Each item	Expand Searches for files and folders — response body — matches item highlight spans array item
highlight_spans (anyOf 2)	null	Alternative

Referenced models: Searches for files and folders — response body — matches item highlight spans array item, Searches for files and folders — response body — matches item metadata, Searches for files and folders — response body — matches item match type value

Searches for files and folders — request body — body options account id, file categories, file extensions, file status, filename only, max results, order by, path file categories array item

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	One of: image, document, pdf, spreadsheet, presentation, audio, video, folder, paper, others
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: image
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: document
$ (anyOf 4)	object	Alternative
$ (anyOf 4)..tag	string	Required within parent	Must equal: pdf
$ (anyOf 5)	object	Alternative
$ (anyOf 5)..tag	string	Required within parent	Must equal: spreadsheet
$ (anyOf 6)	object	Alternative
$ (anyOf 6)..tag	string	Required within parent	Must equal: presentation
$ (anyOf 7)	object	Alternative
$ (anyOf 7)..tag	string	Required within parent	Must equal: audio
$ (anyOf 8)	object	Alternative
$ (anyOf 8)..tag	string	Required within parent	Must equal: video
$ (anyOf 9)	object	Alternative
$ (anyOf 9)..tag	string	Required within parent	Must equal: folder
$ (anyOf 10)	object	Alternative
$ (anyOf 10)..tag	string	Required within parent	Must equal: paper
$ (anyOf 11)	object	Alternative
$ (anyOf 11)..tag	string	Required within parent	Must equal: others
$ (anyOf 12)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 12)..tag	string	Required within parent	Pattern: ^(?!(?:image|document|pdf|spreadsheet|presentation|audio|video|folder|paper|others)$)

Searches for files and folders — response body — matches item highlight spans array item

Field	Type	Presence	Description and constraints
$	object	Root
highlight_str	string	Required within parent
is_highlighted	boolean	Required within parent

Policy, approvals and errors

SDK function policy ID: dropbox.files_search_v2. Catalog operation: files/search_v2. 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