Search files and folders with Dropbox API

Pipedream makes it easy to connect APIs for Dropbox and 2,700+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Search files and folders with the Dropbox API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Search files and folders with the Dropbox API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Search files and folders action
1. Connect your Dropbox account
2. Configure Query
3. Select a Path
4. Optional- Select a Order By
5. Optional- Select a File Status
6. Optional- Configure Filename Only
7. Optional- Select one or more File Categories
8. Optional- Configure File Extensions
9. Optional- Configure Include Highlights
10. Optional- Configure Limit
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Search files and folders with Dropbox API on New Highlights from Readwise API

Readwise + Dropbox

Try it

Search files and folders with Dropbox API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Dropbox

Try it

Search files and folders with Dropbox API on New Item in Feed from RSS API

RSS + Dropbox

Try it

Search files and folders with Dropbox API on New Message from Discord API

Discord + Dropbox

Try it

Search files and folders with Dropbox API on New Message In Channels from Slack API

Slack + Dropbox

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Search files and folders on Dropbox

Description:Searches for files and folders by name. [See the documentation](https://dropbox.github.io/dropbox-sdk-js/Dropbox.html#filesSearchV2__anchor)

Version:0.0.11

Key:dropbox-search-files-folders

View on GitHub

Code#

import isNil from "lodash/isNil.js";
import consts from "../../common/consts.mjs";
import dropbox from "../../dropbox.app.mjs";

export default {
  name: "Search files and folders",
  description: "Searches for files and folders by name. [See the documentation](https://dropbox.github.io/dropbox-sdk-js/Dropbox.html#filesSearchV2__anchor)",
  key: "dropbox-search-files-folders",
  version: "0.0.11",
  type: "action",
  props: {
    dropbox,
    query: {
      propDefinition: [
        dropbox,
        "query",
      ],
    },
    path: {
      propDefinition: [
        dropbox,
        "path",
        () => ({
          filter: ({ metadata: { metadata: { [".tag"]: type } } }) => type === "folder",
        }),
      ],
      description: "Type the folder name to search for it in the user's Dropbox.",
    },
    orderBy: {
      type: "string",
      label: "Order By",
      description: "By default, results are sorted by relevance.",
      optional: true,
      options: consts.SEARCH_FILE_FOLDER_ORDER_BY_OPTIONS,
    },
    fileStatus: {
      type: "string",
      label: "File Status",
      description: "Restricts search to the given file status.",
      optional: true,
      options: consts.SEARCH_FILE_FOLDER_STATUS_OPTIONS,
    },
    filenameOnly: {
      type: "boolean",
      label: "Filename Only",
      description: "Restricts search to only match on filenames.",
      optional: true,
    },
    fileCategories: {
      type: "string[]",
      label: "File Categories",
      description: "Restricts search to only the file categories specified. Only supported for active file search.",
      optional: true,
      options: consts.FILES_CATEGORIES_OPTIONS,
    },
    fileExtensions: {
      type: "string[]",
      label: "File Extensions",
      description: "Restricts search to only the extensions specified. Only supported for active file search.",
      optional: true,
    },
    includeHighlights: {
      type: "boolean",
      label: "Include Highlights",
      description: "Whether to include highlight span from file title.",
      optional: true,
    },
    limit: {
      propDefinition: [
        dropbox,
        "limit",
      ],
    },
  },
  async run({ $ }) {
    const {
      query,
      includeHighlights,
      limit,
      path,
      orderBy,
      fileStatus,
      filenameOnly,
      fileExtensions,
      fileCategories,
    } = this;
    const res = await this.dropbox.searchFilesFolders({
      query,
      match_field_options: !isNil(includeHighlights)
        ? undefined
        : {
          include_highlights: includeHighlights,
        },
      options: {
        path: this.dropbox.getPath(path),
        order_by: orderBy
          ? {
            ".tag": orderBy,
          }
          : undefined,
        file_status: fileStatus
          ? {
            ".tag": fileStatus,
          }
          : undefined,
        filename_only: filenameOnly,
        file_extensions: fileExtensions,
        file_categories: fileCategories
          ? fileCategories.map((category) => ({
            ".tag": category,
          }))
          : undefined,
      },
    }, limit);
    $.export("$summary", "Files and folders successfully fetched");
    return res;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Dropbox	`dropbox`	`app`	This component uses the Dropbox app.
Query	`query`	`string`	The string to search for. May match across multiple fields based on the request arguments.
Path	`path`	`string`	Select a value from the drop down menu.
Order By	`orderBy`	`string`	Select a value from the drop down menu:`relevancelast_modified_time`
File Status	`fileStatus`	`string`	Select a value from the drop down menu:`activedeleted`
Filename Only	`filenameOnly`	`boolean`	Restricts search to only match on filenames.
File Categories	`fileCategories`	`string[]`	Select a value from the drop down menu:`imagedocumentpdfspreadsheetpresentationaudiovideofolderpaperothersother`
File Extensions	`fileExtensions`	`string[]`	Restricts search to only the extensions specified. Only supported for active file search.
Include Highlights	`includeHighlights`	`boolean`	Whether to include highlight span from file title.
Limit	`limit`	`integer`	Specify a max amount of register to be fetched. Defaults to `100` if left blank.

Authentication#

Dropbox uses OAuth authentication. When you connect your Dropbox account, Pipedream will open a popup window where you can sign into Dropbox and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Dropbox API.

Pipedream requests the following authorization scopes when you connect your account:

About Dropbox#

Dropbox gives you secure access to all your files. Collaborate with friends, family, and coworkers from any device.

More Ways to Use Dropbox#

Triggers#

New File from the Dropbox API

Emit new event when a new file is added to your account or a specific folder. Make sure the number of files/folders in the watched folder does not exceed 4000.

Try it

New Folder from the Dropbox API

Emit new event when a new folder is created. Make sure the number of files/folders in the watched folder does not exceed 4000.

Try it

New or Modified File or Folder from the Dropbox API

Emit new event when a file or folder is added or modified. Make sure the number of files/folders in the watched folder does not exceed 4000.

Try it