Data Types

ListFolderChildren

Lists the children (files and sub-folders) of a folder.

Pagination is complete when the response cursor matches the request cursor.

GET /v2/accounts/{accountId}/folders/children
cURL
1curl https://api.upload.io/v2/accounts/{accountId}/folders/children?folderPath=/uploads \
2 -H "Authorization: Bearer YOUR_API_KEY"
Response (200)
1{
2 "children": [
3 {
4 "filePath": "/uploads/image.jpg",
5 "fileUrl": "https://upcdn.io/A623uY2/raw/uploads/image.jpg",
6 "lastModified": 1615680311115,
7 "size": 43182,
8 "type": "File"
9 }
10 ],
11 "cursor": "aGVsbG8=",
12 "parent": {
13 "folderPath": "/uploads",
14 "settings": {
15 "description": "This is an example folder description.",
16 "publicPermissions": [
17 {
18 "permissions": {
19 "file": {
20 "downloadFile": [
21 "thumbnail"
22 ]
23 }
24 },
25 "scope": "Children"
26 }
27 ],
28 "storageLayer": {
29 "type": "InternalStorageV2"
30 }
31 },
32 "status": "Deleting",
33 "type": "Folder"
34 }
35}

Response Body

URL Parameters

accountId

Your account ID.

This is visible on the settings page:

https://upload.io/dashboard/settings

Type: String

Length: 7

Example: A623uY2

In: Path

Required: Yes

cursor

Cursor (aka continuation token) for listing folder children.

Type: String

Example: ?cursor=aGVsbG8=

In: Querystring

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: ?folderPath=/uploads

In: Querystring

Required: Yes

includeFiles

Type: Boolean

In: Querystring

Required: No

includeFolders

Type: Boolean

In: Querystring

Required: No

limit

Folder listing limit.

Type: Integer

Minimum: 1

Maximum: 200

Example: ?limit=50

In: Querystring

Required: No

traverseVirtualFolders

Type: Boolean

In: Querystring

Required: No

Request Headers

Authorization

Add one of these Authorization header values to your request:

Option 1: prefix "Bearer " to your API key. The result is your Authorization header value.

Option 2: use HTTP basic authorization, specifying apikey as your username, and your API key as your password.

Type: String

In: Header

Required: Yes

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: