Get Labeled Files

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 fetches all files and folders associated with a label.

Endpoints

OAuth Scope

WorkDrive.files.READCopied!

Request Example

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

Path Parameters

team_member_idstring(Required)

The unique ID that represents the team member.

Query Parameters

Note:

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

filter[label_id]string(Optional)

To filter files by a particular label, provide the unique ID of a label which needs to be filtered.

filter[type]string(Optional)

To filter by resource type.

Eg. filter[type]=documents

Check all filter types 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
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 indicates from where the listing should start.

sortstring(Optional)

Sorting can be done with these fields: name, kind, shared_time, last_modified, created_time. To sort in descending order, prefix the field value with a hyphen (-).

Allowed Values :
Show Values
nameCopied!
kindCopied!
shared_timeCopied!
last_modifiedCopied!
created_timeCopied!
sizeCopied!
extensionCopied!
typeCopied!
-nameCopied!
-kindCopied!
-shared_timeCopied!
-last_modifiedCopied!
-created_timeCopied!
Copied!Copy all as JSON Array

Response Example

R008

200
200
401
Copied!
  {
    "data": [
      {
        "id": "rryemf2190bd7209d4fb19afdb186095a8e9e",
        "type": "files",
        "attributes": {
          "modified_by_zuid": "54720311",
          "is_locked": false,
          "conv_engine_type": 1,
          "is_fillable_resource": false,
          "is_published": false,
          "destination_id": "af0u7255d9be1a03f451a9c733afd351bf5ba",
          "storage_info": {
            "size": "28.0 KB",
            "storage_used": "28.0 KB",
            "files_count": 0,
            "folders_count": 0,
            "size_in_bytes": 29051,
            "storage_used_in_bytes": 29051,
            "storage_used_by_app_in_bytes": 0,
            "storage_used_by_workdrive_in_bytes": 0
          },
          "type": "image",
          "created_time_i18": "Feb 9, 2018, 2:59 PM",
          "associated_data_templates": [],
          "modified_time_in_millisecond": 1615386944023,
          "status_change_time": "Mar 10, 2021, 8:05 PM",
          "download_url": "https://downloadserver.zoho.com/v1/workdrive/download/rryemf2190bd7209d4fb19afdb186095a8e9e",
          "comment_badge_count": 0,
          "is_app_associated": false,
          "created_time": "Feb 9, 2018, 2:59 PM",
          "lock_status": 2,
          "is_folder": false,
          "resource_type": 2501,
          "is_email_in_upload": false,
          "display_attr_name": "Docs.png",
          "created_by": "Mohammed_TD8",
          "display_html_name": "Docs.png",
          "labels": [
            {
              "id": "5nek5a28a8c9201f64a07b7196524264ed528-181767000000449002",
              "name": "Training materials",
              "color": "14A765",
              "type": 1,
              "label_id": "181767000000449002",
              "team_id": "5nek5a28a8c9201f64a07b7196524264ed528"
            }
          ],
          "parent_id": "af0u7255d9be1a03f451a9c733afd351bf5ba",
          "name": "Docs.png",
          "status_change_time_in_millisecond": 1615386944023,
          "permalink": "https://www.zohoapis.com/workdrive/file/rryemf2190bd7209d4fb19afdb186095a8e9e",
          "favorite": false,
          "new_badge_count": 0,
          "status": 1,
          "modified_time_i18": "Mar 10, 2021, 8:05 PM",
          "extn": "png",
          "shortcut_link": "",
          "status_change_time_i18": "Mar 10, 2021, 8:05 PM",
          "description": "",
          "uploaded_time_in_millisecond": 1615386943805,
          "thumbnail_url": "https://previewengine.zoho.com/thumbnail/WD/rryemf2190bd7209d4fb19afdb186095a8e9e",
          "title": "",
          "modified_time": "Mar 10, 2021, 8:05 PM",
          "library_id": "af0u7255d9be1a03f451a9c733afd351bf5ba",
          "icon_class": "img",
          "created_time_in_millisecond": 1518168569705,
          "owner": "54559548",
          "creator": "54720311",
          "uploaded_time_i18": "Mar 10, 2021, 8:05 PM",
          "is_external_upload": false,
          "watch_preference": {
            "watch": false,
            "notifyemail": false,
            "notifybell": false
          },
          "opened_time_in_millisecond": 0,
          "edit_badge_count": 0,
          "share_data": [],
          "uploaded_time": "Mar 10, 2021, 8:05 PM",
          "has_folders": false,
          "service_type": "upload",
          "display_url_name": "Docs.png",
          "is_unread": false,
          "modified_by": "Mohammed_TD8",
          "embed_props": {}
        },
        "relationships": {
          "folders": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/relationships/folders",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/folders"
            }
          },
          "records": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/relationships/records",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/records"
            }
          },
          "unzip": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/relationships/unzip",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/unzip"
            }
          },
          "accesschartdata": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/relationships/accesschartdata",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/accesschartdata"
            }
          },
          "resourceproperty": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/relationships/resourceproperty",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/resourceproperty"
            }
          },
          "shortcut": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/relationships/shortcut",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/shortcut"
            }
          },
          "importfile": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/relationships/importfile",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/importfile"
            }
          },
          "permissions": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/relationships/permissions",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/permissions"
            }
          },
          "saveastemplate": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/relationships/saveastemplate",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/saveastemplate"
            }
          },
          "links": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/relationships/links",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/links"
            }
          },
          "copy": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/relationships/copy",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/copy"
            }
          },
          "previewzip": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/relationships/previewzip",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/previewzip"
            }
          },
          "tasks": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/relationships/tasks",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/tasks"
            }
          },
          "custommetadata": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/relationships/custommetadata",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/custommetadata"
            }
          },
          "comments": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/relationships/comments",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/comments"
            }
          },
          "previewinfo": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/relationships/previewinfo",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/previewinfo"
            }
          },
          "publiclink": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/relationships/publiclink",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/publiclink"
            }
          },
          "parentfolders": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/relationships/parentfolders",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/parentfolders"
            }
          },
          "versions": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/relationships/versions",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/versions"
            }
          },
          "supportshare": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/relationships/supportshare",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/supportshare"
            }
          },
          "recordsuggestions": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/relationships/recordsuggestions",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/recordsuggestions"
            }
          },
          "timeline": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/relationships/timeline",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/timeline"
            }
          },
          "files": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/relationships/files",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/files"
            }
          },
          "accessdata": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/relationships/accessdata",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/accessdata"
            }
          },
          "breadcrumbs": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/relationships/breadcrumbs",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/breadcrumbs"
            }
          },
          "entity": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/relationships/entity",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/entity"
            }
          },
          "statistics": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/relationships/statistics",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/statistics"
            }
          },
          "appdata": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/relationships/appdata",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e/appdata"
            }
          }
        },
        "links": {
          "self": "https://www.zohoapis.com/workdrive/api/v1/files/rryemf2190bd7209d4fb19afdb186095a8e9e"
        }
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "R008",
        "title": "Unauthorized access"
      }
    ]
  }
                
Show full