Search files with the Dropbox API

Searches files and folders and returns up to max_results matches, each with the item under metadata.metadata. When has_more is true, narrow the query or the folder. Changes from the last moments may not show yet.

Identifier
dropbox_search_files

The request

POST https://connect.reportei.com/api/tools/dropbox_search_files/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "query": "<query>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
querystringYesText to search for, up to 1000 characters. It can match the name and other fields of an item; set filename_only in options to match names only.
optionsobjectNoFilters and limits of the search.

Supported connections

Your customer connects their Dropbox account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/dropbox, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/dropbox_search_files. It becomes your agent's tool definition with no conversion.

Other Dropbox tools

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.