Folders

Folders are where the files are stored.

A WorkDrive User can create a new folder within WorkDrive or upload a folder from the user's desktop, external storage devices, or other cloud resources.

Download Folders OpenAPI Document
Download






List Files/Folders inside a Folder

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

This API lists down all the files and folders present within a folder.

Endpoints

OAuth Scope

WorkDrive.files.READCopied!

Request Example

cURL
cURL
Deluge
Copied!
curl --request GET \
  --url https://www.zohoapis.com/workdrive/api/v1/files/{folder_id}/files \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'

Path Parameters

folder_idstring(Required)

The unique ID that represents a folder.

Query Parameters

Note:

Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here

filter[type]string(Optional)

To filter by resource type.

Eg. filter[type]=allfiles

For list of filter type, see file filter in Filters page, refer here

Allowed Values :
Show Values
allCopied!
allfilesCopied!
documentsCopied!
spreadsheetsCopied!
presentationsCopied!
pdfCopied!
audioCopied!
videoCopied!
imagesCopied!
folderCopied!
mydraftsCopied!
documents_nativeCopied!
spreadsheets_nativeCopied!
presentations_nativeCopied!
documents_non_nativeCopied!
spreadsheets_non_nativeCopied!
presentations_non_nativeCopied!
Copied!Copy all as JSON Array
filter[externalUpload]string(Optional)

Set 'false' to avoid externally uploaded folders.

filter[extension]string(Optional)

Filter resources by their file extensions.

Eg. filter[extension]=docx, jpeg

page[limit]string(Optional)

Limit indicates the number of items to be listed.

(The maximum limit is 50)

For More Details about pagination, refer here

page[offset]string(Optional)

Offset pagination returns 50 items by default. Offset indicates from where the listing should start.

You can change the limit if required.

Learn more about pagination types

page[next]string(Optional)

Cursor pagination returns 1000 items by default. For the initial request, use 0. From the second request, use the page token from the API response.

You can change the limit if required.

Learn more about pagination types

fields[files]string(Optional)

Mention the required params to be included in the response attribute.

Eg:
parent_id,status_change_time_in_millisecond,created_time_in_millisecond,capabilities,type,name,storage_info.


To check the available fields, see the attributes given in the sample response.

Allowed Values :
Show Values
parent_idCopied!
status_change_time_in_millisecondCopied!
created_time_in_millisecondCopied!
capabilitiesCopied!
typeCopied!
nameCopied!
storage_infoCopied!
Copied!Copy all as JSON Array
sortstring(Optional)

Sorting can be done with these fields:


  • name
  • kind
  • shared_time
  • last_modified
  • created_time
  • size
  • extension
  • type

To sort in descending order, prefix the field value with a hyphen (-).

Eg. sort=-name sorts results by name in descending order.

Response Example

R008

I026

I026

F000

200
200
204
401
500
Copied!
  {
    "data": [
      {
        "id": "cjrrr1b298cf52cf44acebc713ab5b73bbd77",
        "type": "files",
        "attributes": {
          "modified_by_zuid": "747938014",
          "is_locked": false,
          "conv_engine_type": 0,
          "is_fillable_resource": false,
          "is_published": false,
          "destination_id": "cjrrr27f73d5b59a54b16aaf3cd74478a0fa2",
          "storage_info": {
            "size": "0 bytes",
            "storage_used": "0 bytes",
            "files_count": 0,
            "folders_count": 0,
            "size_in_bytes": 0,
            "storage_used_in_bytes": 0
          },
          "type": "folder",
          "created_time_i18": "Apr 13, 10:58 AM",
          "modified_time_in_millisecond": 1618291736244,
          "opened_time": "Apr 13, 10:58 AM",
          "status_change_time": "Apr 13, 10:58 AM",
          "download_url": "https://www.zohoapis.com/workdrive/download/cjrrr1b298cf52cf44acebc713ab5b73bbd77",
          "comment_badge_count": 0,
          "is_app_associated": false,
          "created_time": "Apr 13, 10:58 AM",
          "lock_status": 2,
          "is_folder": true,
          "resource_type": 1001,
          "is_email_in_upload": false,
          "display_attr_name": "April",
          "created_by": "Zylker Creation",
          "display_html_name": "April",
          "labels": [],
          "parent_id": "cjrrr27f73d5b59a54b16aaf3cd74478a0fa2",
          "name": "April",
          "status_change_time_in_millisecond": 1618291736244,
          "permalink": "https://www.zohoapis.com/workdrive/folder/cjrrr1b298cf52cf44acebc713ab5b73bbd77",
          "favorite": false,
          "new_badge_count": 0,
          "status": 1,
          "modified_time_i18": "Apr 13, 10:58 AM",
          "opened_time_i18": "Apr 13, 10:58 AM",
          "extn": "",
          "view_pref": {
            "sort_by": "last_modified",
            "sort_order": "desc",
            "filtered_by": "all",
            "layout": "list"
          },
          "shortcut_link": "",
          "status_change_time_i18": "Apr 13, 10:58 AM",
          "description": "",
          "uploaded_time_in_millisecond": 1618291736244,
          "thumbnail_url": "",
          "title": "",
          "files_view_pref": {
            "sort_by": "last_modified",
            "sort_order": "desc",
            "filtered_by": "all",
            "layout": "list"
          },
          "modified_time": "Apr 13, 10:58 AM",
          "library_id": "ly9zm0170fb40015f4e2297a144e2b68cfa68",
          "icon_class": "folder",
          "created_time_in_millisecond": 1618291736244,
          "owner": "747937818",
          "creator": "747938014",
          "capabilities": {
            "can_read": true,
            "can_share": true,
            "can_remove_share": false,
            "can_delete": false,
            "can_edit": true,
            "can_create_files": true,
            "can_upload_files": true,
            "can_trash": true,
            "can_rename": true,
            "can_restore": false,
            "can_copy": true,
            "can_move": true,
            "can_zip": true,
            "can_download": true,
            "can_emailattach": true,
            "can_publish": true,
            "can_create_task": false,
            "can_share_support": true,
            "can_label": true,
            "can_trash_files": true
          },
          "uploaded_time_i18": "Apr 13, 10:58 AM",
          "is_external_upload": false,
          "watch_preference": {
            "watch": false,
            "notifyemail": false,
            "notifybell": false
          },
          "opened_time_in_millisecond": 1618291736244,
          "edit_badge_count": 0,
          "share_data": [],
          "uploaded_time": "Apr 13, 10:58 AM",
          "has_folders": false,
          "service_type": "upload",
          "display_url_name": "April",
          "is_unread": false,
          "modified_by": "Zylker Creation",
          "embed_props": {}
        },
        "relationships": {
          "folders": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/relationships/folders",
              "related": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/folders"
            }
          },
          "comments": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/relationships/comments",
              "related": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/comments"
            }
          },
          "previewinfo": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/relationships/previewinfo",
              "related": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/previewinfo"
            }
          },
          "unzip": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/relationships/unzip",
              "related": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/unzip"
            }
          },
          "publiclink": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/relationships/publiclink",
              "related": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/publiclink"
            }
          },
          "resourceproperty": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/relationships/resourceproperty",
              "related": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/resourceproperty"
            }
          },
          "parentfolders": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/relationships/parentfolders",
              "related": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/parentfolders"
            }
          },
          "shortcut": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/relationships/shortcut",
              "related": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/shortcut"
            }
          },
          "importfile": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/relationships/importfile",
              "related": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/importfile"
            }
          },
          "versions": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/relationships/versions",
              "related": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/versions"
            }
          },
          "supportshare": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/relationships/supportshare",
              "related": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/supportshare"
            }
          },
          "permissions": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/relationships/permissions",
              "related": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/permissions"
            }
          },
          "timeline": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/relationships/timeline",
              "related": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/timeline"
            }
          },
          "files": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/relationships/files",
              "related": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/files"
            }
          },
          "saveastemplate": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/relationships/saveastemplate",
              "related": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/saveastemplate"
            }
          },
          "links": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/relationships/links",
              "related": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/links"
            }
          },
          "copy": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/relationships/copy",
              "related": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/copy"
            }
          },
          "previewzip": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/relationships/previewzip",
              "related": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/previewzip"
            }
          },
          "tasks": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/relationships/tasks",
              "related": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/tasks"
            }
          },
          "breadcrumbs": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/relationships/breadcrumbs",
              "related": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/breadcrumbs"
            }
          },
          "entity": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/relationships/entity",
              "related": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/entity"
            }
          },
          "custommetadata": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/relationships/custommetadata",
              "related": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/custommetadata"
            }
          },
          "statistics": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/relationships/statistics",
              "related": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/statistics"
            }
          },
          "appdata": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/relationships/appdata",
              "related": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77/appdata"
            }
          }
        },
        "links": {
          "self": "https://www.zohoapis.com/workdrive/files/cjrrr1b298cf52cf44acebc713ab5b73bbd77"
        }
      }
    ],
    "links": {
      "cursor": {
        "has_next": true,
        "next": "https://www.zohoapis.com/workdrive/api/v1/files/vliy1b942de68431c4b92994025adf85d53fa/files?page[next]=dd1c097d208ec12c5093e359d5859fcce97ddbab18389052caa7d6ed2d6d37b073a8e94e651cfaf15c9c28d46b91b173663e37138b530a40854f2e27a31c"
      }
    }
  }
                
204 No Content
  {
    "errors": [
      {
        "id": "R008",
        "title": "Unauthorized access"
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "I026",
        "title": "Invalid resource type"
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "F000",
        "title": "General Exception"
      }
    ]
  }
                
Show full