← Dropbox

List All Files/Subfolders in a Folder with Dropbox API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
List All Files/Subfolders in a Folder with the Dropbox API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜

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

Adyen logo
Brex logo
Carta logo
Checkr logo
Chameleon logo
DevRev logo
LinkedIn logo
Netflix logo
New Relic logo
OnDeck logo
Replicated logo
Scale AI logo
Teamwork logo
Warner Bros. logo
Xendit logo

Developers Pipedream

Getting Started

Create a workflow to List All Files/Subfolders in a Folder with the Dropbox API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the List All Files/Subfolders in a Folder action
    1. Connect your Dropbox account
    2. Select a Path
    3. Configure Recursive
    4. Configure Include deleted
    5. Configure Include has explicit shared members
    6. Configure Include mounted folders
    7. Configure Include non downloadable files
    8. Optional- Configure Limit
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

List All Files/Subfolders in a Folder with Dropbox API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Dropbox
 
Try it
List All Files/Subfolders in a Folder with Dropbox API on New Item in Feed from RSS API
RSS + Dropbox
 
Try it
List All Files/Subfolders in a Folder with Dropbox API on New Message from Discord API
Discord + Dropbox
 
Try it
List All Files/Subfolders in a Folder with Dropbox API on New Message In Channels from Slack API
Slack + Dropbox
 
Try it
List All Files/Subfolders in a Folder with Dropbox API on New Message in Channel from Discord Bot API
Discord Bot + 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.

List All Files/Subfolders in a Folder on Dropbox
Description:Retrieves a list of files or subfolders in a specified folder [See the docs here](https://dropbox.github.io/dropbox-sdk-js/Dropbox.html#filesListFolder__anchor)
Version:0.0.4
Key:dropbox-list-file-folders-in-a-folder

Code

import dropbox from "../../dropbox.app.mjs";

export default {
  name: "List All Files/Subfolders in a Folder",
  description: "Retrieves a list of files or subfolders in a specified folder [See the docs here](https://dropbox.github.io/dropbox-sdk-js/Dropbox.html#filesListFolder__anchor)",
  key: "dropbox-list-file-folders-in-a-folder",
  version: "0.0.4",
  type: "action",
  props: {
    dropbox,
    path: {
      propDefinition: [
        dropbox,
        "pathFolder",
      ],
      description: "Scopes the search to a path in the user's Dropbox.",
    },
    recursive: {
      type: "boolean",
      label: "Recursive",
      description: "If `true`, the list folder operation will be applied recursively to all subfolders and the response will contain contents of all subfolders.",
      default: true,
    },
    includeDeleted: {
      type: "boolean",
      label: "Include deleted",
      description: "If `true`, the results will include files and folders that used to exist but were deleted.",
      default: false,
    },
    includeHasExplicitSharedMembers: {
      type: "boolean",
      label: "Include has explicit shared members",
      description: "If `true`, the results will include a flag for each file indicating whether or not that file has any explicit members.",
      default: false,
    },
    includeMountedFolders: {
      type: "boolean",
      label: "Include mounted folders",
      description: "If `true`, the results will include entries under mounted folders which includes app folder, shared folder and team folder.",
      default: false,
    },
    includeNonDownloadableFiles: {
      type: "boolean",
      label: "Include non downloadable files",
      description: "If `true`, include files that are not downloadable, i.e. Google Docs.",
      default: true,
    },
    limit: {
      propDefinition: [
        dropbox,
        "limit",
      ],
    },
  },
  async run({ $ }) {
    const {
      limit,
      path,
      recursive,
      includeDeleted,
      includeHasExplicitSharedMembers,
      includeMountedFolders,
      includeNonDownloadableFiles,
    } = this;
    const res = await this.dropbox.listFilesFolders({
      path: path?.value || path,
      recursive,
      include_deleted: includeDeleted,
      include_has_explicit_shared_members: includeHasExplicitSharedMembers,
      include_mounted_folders: includeMountedFolders,
      include_non_downloadable_files: includeNonDownloadableFiles,
    }, limit);
    $.export("$summary", `Files and folders in the path ${path?.label || path} 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.
LabelPropTypeDescription
DropboxdropboxappThis component uses the Dropbox app.
PathpathstringSelect a value from the drop down menu.
Recursiverecursiveboolean

If true, the list folder operation will be applied recursively to all subfolders and the response will contain contents of all subfolders.

Include deletedincludeDeletedboolean

If true, the results will include files and folders that used to exist but were deleted.

Include has explicit shared membersincludeHasExplicitSharedMembersboolean

If true, the results will include a flag for each file indicating whether or not that file has any explicit members.

Include mounted foldersincludeMountedFoldersboolean

If true, the results will include entries under mounted folders which includes app folder, shared folder and team folder.

Include non downloadable filesincludeNonDownloadableFilesboolean

If true, include files that are not downloadable, i.e. Google Docs.

Limitlimitinteger

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 or Modified File or Folder from the Dropbox API

Emits an 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
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

Actions

Create a Text File with the Dropbox API

Creates a brand new text file from plain text content you specify. See docs here

 
Try it
Create folder with the Dropbox API

Create a folder. See docs here

 
Try it
Create or Append to a Text File with the Dropbox API

Adds a new line to an existing text file, or creates a file if it doesn't exist. See docs here

 
Try it
Create/Update a Share Link with the Dropbox API

Creates or updates a public share link to the file or folder (It allows to share the file or folder with anyone). See docs here

 
Try it
Delete a File/Folder with the Dropbox API

Permanently removes a file/folder from the server. See docs here

 
Try it