ListFolderChildrenParams

Parameter object passed to the ListFolderChildren method in the Upload SDKs.

Structure

{
  "accountId": String,
  "cursor": String,
  "folderPath": String,
  "includeFiles": Boolean,
  "includeFolders": Boolean,
  "limit": Integer,
  "traverseVirtualFolders": Boolean
}

Example

{
  "accountId": "YOUR_ACCOUNT_ID",
  "cursor": "aGVsbG8=",
  "folderPath": "/uploads",
  "includeFiles": true,
  "includeFolders": true,
  "limit": 50,
  "traverseVirtualFolders": true
}

Properties

accountId

Your account ID.

This is visible on the settings page:

https://upload.io/dashboard/settings

Type: String

Length: 7

Example: "A623uY2"

Required: No

cursor

Cursor (aka continuation token) for listing folder children.

Type: String

Example: "aGVsbG8="

Required: No

folderPath

Absolute path to a folder. Must begin with a /. Should not end with a /.

Type: String

Min Length: 1

Max Length: 512

Example: "/uploads"

Required: No

includeFiles

Type: Boolean

Required: No

includeFolders

Type: Boolean

Required: No

limit

Folder listing limit.

Type: Integer

Minimum: 1

Maximum: 200

Example: 50

Required: No

traverseVirtualFolders

Type: Boolean

Required: No

Was this section helpful? Yes No

You are using an outdated browser.

This website requires a modern web browser -- the latest versions of these browsers are supported:

Documentation

Data Types

More Resources

ListFolderChildrenParams

Structure

Example

Properties

accountId

cursor

folderPath

includeFiles

includeFolders

limit

traverseVirtualFolders

You are using an outdated browser.