Dropbox List

This Snap lists files and folders in a Dropbox directory.

Supported Accounts

Prerequisites

None.

Limitations and known issues

None.

Snap views

Type Description Examples of upstream and downstream Snaps
Input

This Snap has at most one document input view. If an input view is defined, the Snap reads the folder path from the incoming document.

If no input view is connected, the folder path must be specified in the Snap settings.
Output

This Snap has exactly one document output view. The Snap outputs one document for each file or folder found in the specified path.
Learn more about Error handling.

Snap settings

Note: Learn about the common controls in the Snap settings dialog.
Field/Field set Description

Label

String

 Required.Specify a unique name for the Snap. Modify this to be more appropriate, especially if there are more than one of the same Snap in the pipeline.

Default value: Dropbox List
Folder path*

String/Expression

 The path to the folder in Dropbox to list. Use an empty string or "/" to list the root folder.

Example: /Documents

Default value: None
Include subfolders

Checkbox

 Select this checkbox to recursively list all files and folders in subdirectories.

Default value: Deselected
Limit

Integer/Expression

 Specify the maximum number of files and folders to return. Set to 0 for no limit.

Example: 500

Default value: 0
Sync mode

Dropdown list

 Select the synchronization mode for listing files:
  • Full: List all files in the specified folder
  • Incremental: List only files that have changed since the last cursor position

Default value: Full
Cursor

String/Expression

 Specify the cursor value for incremental sync mode. This cursor tracks the position in the folder listing.

Example: $cursor

Default value: None
File type filter

String/Expression

 Specify a filter to include only specific file types. Use file extensions separated by commas.

Example: .pdf,.docx,.txt

Default value: None
Modified after

String/Expression

 Specify a date/time to list only files modified after this timestamp.

Example: 2024-01-01T00:00:00Z

Default value: None
Modified before

String/Expression

 Specify a date/time to list only files modified before this timestamp.

Example: 2024-12-31T23:59:59Z

Default value: None
Maximum file size (MB)

Integer/Expression

 Specify the maximum file size in megabytes to include in the results. Set to 0 for no limit.

Example: 100

Default value: 0
Include team folders

Checkbox

 Select this checkbox to include team folders in the results when using a Dropbox Business account.

Default value: Deselected
Include shared folders

Checkbox

 Select this checkbox to include shared folders in the results.

Default value: Deselected
Shared folder ID

String/Expression

 Specify the shared folder ID to list files from a specific shared folder.

Example: 1234567890

Default value: None
Snap execution

Dropdown list
Choose one of the three modes in which the Snap executes. Available options are:
  • Validate & Execute: Performs limited execution of the Snap and generates a data preview during pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during pipeline runtime.
  • Execute only: Performs full execution of the Snap during pipeline execution without generating preview data.
  • Disabled: Disables the Snap and all Snaps that are downstream from it.

Default value: Validate & Execute