Dropbox: Starts returning the contents of a folder

← Files operations · Get started

Operation dropbox.files_list_folder

Provider route: POST /2/files/list_folder. 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"]["listFolder"]>[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.listFolder(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.list_folder(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 Starts returning the contents of a folder — request body — body

Referenced models: Deletes a group — request body — headers Dropbox-API-Path-Root, Starts returning the contents of a folder — 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 Starts returning the contents of a folder — response body

Referenced models: Starts returning the contents of a folder — response body

Schemas

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

Starts returning the contents of a folder — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
path	string	Required within parent	Pattern: ^(?:(/(.|[\r\n])*)?|id:.*|(ns:[0-9]+(/(.|[\r\n])*)?))$
recursive	boolean	Optional
include_media_info	boolean	Optional
include_deleted	boolean	Optional
include_has_explicit_shared_members	boolean	Optional
include_mounted_folders	boolean	Optional
limit	JSON	Optional
limit (anyOf 1)	integer	Alternative	Minimum: 1 Maximum: 2000
limit (anyOf 2)	null	Alternative
shared_link	JSON	Optional
shared_link (anyOf 1)	Model	Alternative	Expand Starts returning the contents of a folder — request body — body shared link password, url
shared_link (anyOf 2)	null	Alternative
include_property_groups	JSON	Optional
include_property_groups (anyOf 1)	Model	Alternative	Expand Returns the metadata for a file or folder — request body — body include property groups value
include_property_groups (anyOf 2)	null	Alternative
include_non_downloadable_files	boolean	Optional
include_restorable_info	boolean	Optional

Referenced models: Returns the metadata for a file or folder — request body — body include property groups value, Starts returning the contents of a folder — request body — body shared link password, url

Starts returning the contents of a folder — response body

Field	Type	Presence	Description and constraints
$	object	Root
entries	array	Required within parent
entries[]	Model	Each item	Expand Returns the metadata for a file or folder — response body
cursor	string	Required within parent	Minimum length: 1
has_more	boolean	Required within parent

Referenced models: Returns the metadata for a file or folder — response body

Returns the metadata for a file or folder — request body — body include property groups value

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative
$ (anyOf 1)..tag	string	Required within parent	Must equal: filter_some
$ (anyOf 1).filter_some	array	Required within parent	Minimum items: 1
$ (anyOf 1).filter_some[]	string	Each item	Minimum length: 1 Pattern: ^(?:(/|ptid:).*)$
$ (anyOf 2)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 2)..tag	string	Required within parent	Pattern: ^(?!(?:filter_some)$)

Starts returning the contents of a folder — request body — body shared link password, url

Field	Type	Presence	Description and constraints
$	object	Root
url	string	Required within parent
password	JSON	Optional
password (anyOf 1)	string	Alternative
password (anyOf 2)	null	Alternative

Add property groups to a Dropbox file — request body — body property groups item

Field	Type	Presence	Description and constraints
$	object	Root	A subset of the property fields described by the corresponding PropertyGroupTemplate. Properties are always added to a Dropbox file as a PropertyGroup. The possible key names and value types in this group are defined by the corresponding PropertyGroupTemplate.
template_id	string	Required within parent	Minimum length: 1 Pattern: ^(?:(/|ptid:).*)$
fields	array	Required within parent
fields[]	Model	Each item	Expand Add property groups to a Dropbox file — request body — body property groups item fields item

Referenced models: Add property groups to a Dropbox file — request body — body property groups item fields item

Restore a specific revision of a file to the given path — response body — export info Export information for a file

Field	Type	Presence	Description and constraints
$	object	Root	Export information for a file.
export_as	JSON	Optional
export_as (anyOf 1)	string	Alternative
export_as (anyOf 2)	null	Alternative
export_options	JSON	Optional
export_options (anyOf 1)	array	Alternative
export_options (anyOf 1)[]	string	Each item
export_options (anyOf 2)	null	Alternative

Restore a specific revision of a file to the given path — response body — file lock info created, is lockholder, lockholder account id, lockholder name

Field	Type	Presence	Description and constraints
$	object	Root
is_lockholder	JSON	Optional
is_lockholder (anyOf 1)	boolean	Alternative
is_lockholder (anyOf 2)	null	Alternative
lockholder_name	JSON	Optional
lockholder_name (anyOf 1)	string	Alternative
lockholder_name (anyOf 2)	null	Alternative
lockholder_account_id	JSON	Optional
lockholder_account_id (anyOf 1)	string	Alternative	Maximum length: 40 Minimum length: 40
lockholder_account_id (anyOf 2)	null	Alternative
created	JSON	Optional
created (anyOf 1)	string	Alternative
created (anyOf 2)	null	Alternative

Restore a specific revision of a file to the given path — response body — sharing info modified by, parent shared folder id, read only

Field	Type	Presence	Description and constraints
$	object	Root	Sharing info for a file which is contained by a shared folder.
read_only	boolean	Required within parent
parent_shared_folder_id	string	Required within parent	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
modified_by	JSON	Optional
modified_by (anyOf 1)	string	Alternative	Maximum length: 40 Minimum length: 40
modified_by (anyOf 2)	null	Alternative

Restore a specific revision of a file to the given path — response body — symlink info target

Field	Type	Presence	Description and constraints
$	object	Root
target	string	Required within parent

Restore a specific revision of a file to the given path — response body — media info value

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	Known values: pending
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: pending
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: metadata
$ (anyOf 3).metadata	Model	Required within parent	Expand Restore a specific revision of a file to the given path — response body — media info value tag metadata metadata

Referenced models: Restore a specific revision of a file to the given path — response body — media info value tag metadata metadata

Add property groups to a Dropbox file — request body — body property groups item fields item

Field	Type	Presence	Description and constraints
$	object	Root	Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a PropertyGroup.
name	string	Required within parent
value	string	Required within parent

Policy, approvals and errors

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