Overview
Zoho WorkDrive is an online content collaboration platform designed for teams and individuals to store, share, manage, and collaborate on files of any size.
Zoho WorkDrive provides users and developers with an extensive set of APIs to help integrate functionalities of Zoho Workdrive with other Zoho applications and third-party tools.
It also includes content-based search, preview, external sharing, and a lot more.
Zoho WorkDrive offers two API functionalities:
1. Admin-related Zoho WorkDrive APIs- Manage teams and team folders
- Access team member files and update collaborative permissions
- Create Data Templates and custom fields, and associate resources
- Control overall resource-sharing permissions
- Create Groups and manage Group members
2. Non-Admin-related Zoho WorkDrive APIs
- Downloading files from WorkDrive and uploading files to WorkDrive
- Efficient searching for data using the file name, text keywords and image content, using multiple filters
- Accessing and sharing files and folders to collaborate on content
- Externally sharing a file or folder with a custom share link
- Collecting files from external and internal users
- Following updates on important data using either bell notifications, email notifications, or both
OAuth 2.0 Authentication
Overview
OAuth 2.0 is an industry-standard protocol for authentication and authorization. This protocol provides a secure authorization framework that enables a host of third-party client applications to gain secure and delegated access to protected resources in Zoho through APIs.
Some common characteristics of OAuth 2.0 are:
- Clients are not required to support password authentication or store user credentials. API calls can be made to access resources without having to provide user credentials for each call.
- Clients will only have access to resources authenticated by the user.
- Users can revoke the client's delegated access at any time.
- OAuth2.0 access tokens expire after a set time, which provides strong security.
How does it work?
![](/apidoc/img/oauth2flow.jpg)
Terminologies
The following terms are helpful to know before you start using the Zoho WorkDrive APIs.
Protected resourcesThe Zoho WorkDrive resources, such as Team, Team Folders, and Files & Folders.
Resource serverThe Zoho WorkDrive server that hosts protected resources.
Resource ownerAny end-user of your account who can grant access to the protected resources.
ClientAn application that sends requests to the resource server to access the protected resources on behalf of the end-user.
Client IDThe consumer key generated from the connected application.
Client SecretThe consumer secret generated from the connected application.
Authentication serverAuthorization server provides the necessary credentials (such as Access and Refresh tokens) to the client. In this case, it will be the Zoho WorkDrive authorization server.
Authentication codeThe authorization server creates a temporary token and sends it to the client via the browser. The client will send this code to the authorization server to obtain access and refresh tokens.
Tokens
Access TokenA token that is sent to the resource server to access the protected resources of the user. The Access token provides secure and temporary access to Zoho WorkDrive APIs and is used by the applications to make requests to the connected app. Each access token will only be valid for an hour and can be used only for the set of operations that are described in the scope.
Refresh TokenA token that can be used to obtain new access tokens. This token has an unlimited lifetime until it is revoked by the end-user.
Important
User Access Token must be kept confidential because it defines the type of API that you use. Do not expose your Access Token anywhere in public forums, public repositories, or on your website's client-side code like HTML or JavaScript. Exposing it to the public may lead to data theft, loss, or corruption.
Scopes
Zoho WorkDrive APIs use selected scopes, which control the type of resource that the client application can access. Tokens are usually created with various scopes to ensure improved security. For example, you can generate a scope to create or view a Team Folder or to view File Metadata. Scopes contain three parameters: Service Name, Scope Name, and OperationType. The format to define a Scope is: scope=ServiceName.Scope Name.OperationType
Example:
https://accounts.zoho.com/oauth/v2/auth?scope=WorkDrive.team.ALL
Here, WorkDrive is the service name, scope name would be scopes mentioned in the below table, and ALL is the operation type.
List of Scopes available in Zoho WorkDrive
Scope Name | Description |
team | To access team related APIs Available scopes: WorkDrive.team.CREATE, WorkDrive.team.READ,WorkDrive.team.UPDATE, WorkDrive.team.DELETE. |
members | To add or manage team members in a team Available scopes: WorkDrive.members.READ,WorkDrive.members.CREATE, WorkDrive.members.UPDATE, WorkDrive.members.DELETE. |
teamfolders | To access team folder related APIs Available scopes: WorkDrive.teamfolders.CREATE, WorkDrive.teamfolders.READ,WorkDrive.teamfolders.UPDATE, WorkDrive.teamfolders.DELETE. |
teamfolders.sharing | To add or manage members in a team folder Available scopes: WorkDrive.teamfolders.sharing.CREATE, WorkDrive.teamfolders.sharing.READ,WorkDrive.teamfolders.sharing.UPDATE, WorkDrive.teamfolders.sharing.DELETE. |
teamfolders.admin | To perform admin-related operation in a team folder Available scopes: WorkDrive.teamfolders.admin.READ |
groups | To access group related APIs Available scopes: WorkDrive.groups.CREATE, WorkDrive.groups.READ,WorkDrive.groups.UPDATE, WorkDrive.groups.DELETE |
files | To access files related APIs Available scopes: WorkDrive.files.CREATE, WorkDrive.files.READ,WorkDrive.files.UPDATE, WorkDrive.files.DELETE. |
links | To access external links related APIs Available scopes: WorkDrive.links.CREATE, WorkDrive.links.READ,WorkDrive.links.UPDATE, WorkDrive.links.DELETE. |
comments | To access comments related APIs Available scopes: WorkDrive.comments.CREATE, WorkDrive.comments.READ,WorkDrive.comments.UPDATE, WorkDrive.comments.DELETE. |
collection | To access collect files related APIs Available scopes: WorkDrive.collection.CREATE, WorkDrive.collection.READ,WorkDrive.collection.UPDATE, WorkDrive.collection.DELETE. |
datatemplates | To access data templates and custom fields related APIs Available scopes: WorkDrive.datatemplates.CREATE, WorkDrive.datatemplates.READ,WorkDrive.datatemplates.UPDATE, WorkDrive.datatemplates.DELETE. |
labels | To access labels related APIs Available scopes: WorkDrive.labels.CREATE, WorkDrive.labels.READ,WorkDrive.labels.UPDATE, WorkDrive.labels.DELETE. |
libraries | To access templates related APIs Available scopes: WorkDrive.libraries.CREATE, WorkDrive.libraries.READ,WorkDrive.libraries.UPDATE |
libraries.sharing | To access permission details of a template library Available scopes: WorkDrive.libraries.sharing.READ |
libraries.categories | To access template categories related APIs Available scopes: WorkDrive.libraries.categories.CREATE, WorkDrive.libraries.categories.READ,WorkDrive.libraries.categories.UPDATE |
Register your application
Before you get started with authorization and make any calls using the Zoho WorkDrive APIs, you need to register your application with the Zoho developer console.
1. Go to the Zoho API Console and click Get Started.
![](/apidoc/img/apiconsole.png)
2. Select a client type for your application.
![](/apidoc/img/apiconsole1.png)
For more details, refer to OAuth Overview.
3. Provide the required details to register your application for the client type you chose
- Client Name: The name of your application you want to register with Zoho
- Homepage URL: The URL of your client's homepage
- Authorized Redirect URIs: A valid URL of your application that Zoho Accounts redirect you to with the grant token after a successful authentication
4. Click CREATE.
5. You will receive the following credentials:
- Client ID: The consumer key generated from the connected app.
- Client Secret: The consumer secret generated from the connected app.
![](/apidoc/img/apiconsole2.png)
- You must not share the client_id and client_secret anywhere. Ensure that you keep these credentials safe.
- If you don't have a domain name and a redirect URL, you can use dummy values in their place and register your client.
Possible Errors
-
Enter a valid client name
Resolution: The client name has a special character. The client name must not contain any special characters except "_" and "&".
-
Enter a valid JavaScript Domain URI
Resolution: The JavaScript domain is incorrect. Specify valid JavaScript domains, separated by commas, and they must start with 'http'.
-
Enter a valid redirect URI
Resolution: The redirect URI is incorrect. Specify a valid redirect URI in the format "https://www.your-domain.com/callback".
-
Enter a valid homepage URL
Resolution: The homepage URL is invalid. Specify a valid homepage URL in the format "https://www.yourdomain.com".
Enable Multi-DC for the Client
As mentioned in the Multi-DC Support section, you can enable multi-DC support for your client from the Settings tab in the API console after you register it. This is available for all client types, except the Self Client type, as it is used only for testing.
After registering your client, you can enable Multi DC in the SETTINGS tab. With this option, you can decide which users from which domain can access the web application.
![](/apidoc/img/apiconsole3.png)
As shown in the above screenshot, users from Europe, Australia, and India can access the web-based client. The client ID remains the same, and the client secret differs from one DC to another. You can also choose to have the same client secret across multiple domains based on your business needs by checking the Use the same OAuth credentials for all data centers checkbox. You must then click OK in the confirmation pop-up.
![](/apidoc/img/apiconsole4.png)
Authorization Request
To use the Zoho WorkDrive APIs, users must authenticate the application to make API calls on their behalf with an access token.
The access token, in return, must be obtained from a grant token (authorization code). The Zoho WorkDrive APIs use the authorization code grant type to provide access to protected resources.
There are two ways in which you can generate the grant token based on the client type.
- Web-based application
- Self-client
Web-based applications are chosen when your application is used by multiple users and requires user intervention during authorization. For this client type,you must use redirection-based code generation. In this authorization flow,
- The user clicks the Login with Zoho button on any third-party web-based application.
- The application redirects the user to the Zoho Login page, and the user enters the Zoho credentials.
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
scopestring | |
client_idstring | |
response_typestring | |
access_typestring | |
redirect_uristring | |
statestring |
If you send the prompt parameter in this request, a user consent page will open.
![](/apidoc/img/authrequest.png)
After you click Accept, Zoho will redirect you to the redirect_uri with the Grant Token in the code parameter. Save the code value for the next steps.
https://content.manage.com/app?code=1000.924cb489165a61f27084704e863a9e82.5fed7eda4d0dcf1a42a96447bbfd5b9f&location=us&accounts-server=https%3A%2F%2Faccounts.zoho.com&state=register
Based on your login details, the system automatically detects your domain and uses the domain-specific authentication URL to generate the Grant Token. The state parameter is also passed in the URL.
If you click Reject, the browser redirects to the redirect URI with the parameter error=access_denied.
Note:
This code is only valid for 60 seconds. You must complete the next step within this time.
Example Request
GET https://accounts.zoho.com/oauth/v2/auth?scope=WorkDrive.files.ALL&client_id={client_id}&response_type=code&access_type={offline(or)online}&redirect_uri={redirect_uri}&state=register
Generate Access And Refresh Token
OAuth2.0 requests are usually authenticated with an access token, which is passed as a bearer token. To use this access token, you need to construct a normal HTTP request and include it in an Authorization header along with the value of the bearer.
- You must use your domain-specific Zoho Accounts URL to generate access and refresh tokens. The following are the various domains and their corresponding account URLs:
- For US: https://accounts.zoho.com
- For AU: https://accounts.zoho.com.au
- For EU: https://accounts.zoho.eu
- For IN: https://accounts.zoho.in
- For CN: https://accounts.zoho.com.cn
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
codestring | Mandatory The Grant Token or the value of code obtained in the previous step. |
client_idstring | Mandatory The Client ID that was generated during the client registration. |
client_secretstring | Mandatory The Client Secret that was generated during the client registration. |
redirect_uristring | Mandatory One of the Authorized Redirect URIs you provided while registering the client in the previous step. You must not provide an unregistered redirect URI. |
grant_typestring | Mandatory authorization_code (Provide this literal string as the value) |
scopestring | Mandatory The scope the access_token is to be generated for. You can provide multiple scopes by separating them using commas. |
statestring | Optional An opaque string that is round-tripped in the protocol. In other words, whatever value you provide here will be passed back to you. |
After you obtain the Grant Token, send a POST request to this api with the params given below to generate the access_token:
Response ParametersParameter | Description |
access_token | Access token to access Zoho WorkDrive APIs. |
refresh_token | Refresh token to obtain new access tokens. |
expires_in | Time in seconds after which the access token expires. |
token_type | Type of token obtained. "Bearer" indicates this is an access token. |
This completes the authentication. Once your app receives the access token, send the token in your HTTP authorization header to Zoho WorkDrive API with the value "Zoho-oauthtoken {access_token}" for each endpoint (for each request).
- Each access token is valid for only an hour and can be used only for the operations defined in the scope.
- A refresh token does not expire. Use it to refresh access tokens when they expire. For more details on the validity of the tokens, refer to Token Validity page.
Possible Errors
-
invalid_client
Resolution: You have passed an invalid Client ID or secret. Specify the correct client ID and secret.
(or)
There is a domain mismatch. You have registered the client and generated the grant token in a certain domain (US) but generated the tokens from a different domain (EU). Ensure that you generate the grant, access, and refresh tokens from the same domain using the same domain URL or Enable Multi-DC for your client to generate tokens from any domain.
(or)
You have passed the wrong client secret when multi-DC is enabled. Each DC holds a unique client secret. Ensure to pass the right client secret for that DC.
-
invalid_code
Resolution: The grant token has expired. The grant token is valid only for one minute in the redirection-based flow. Generate the access and refresh tokens before the grant token expires.
(or)
You have already used the grant token. You can use the grant token only once.
(or)
The refresh token to generate a new access token is wrong or revoked. Specify the correct refresh token value while refreshing an access token.
-
3. invalid_redirect_uri
Resolution: The redirect URI in the request does not match the one registered in the developer console. Specify the correct redirect URI in the request.
Example Request
POST https://accounts.zoho.com/oauth/v2/token?code={code}&client_secret={client_secret}&redirect_uri={redirect_uri}&grant_type=authorization_code&client_id={client_id}
Example Response
{ access_token: "1000.a*********************b.2**************************e", refresh_token: "1000.a*********************2.0**************************0", token_type: "Bearer", expires_in: 3600 }
Regenerate Access Token
Access tokens expire after an hour of generation. To generate a new access token, use the refresh token you generated earlier.
- You must use your domain-specific Zoho Accounts URL to refresh your access token.
- For US: https://accounts.zoho.com
- For AU: https://accounts.zoho.com.au
- For EU: https://accounts.zoho.eu
- For IN: https://accounts.zoho.in
- For CN: https://accounts.zoho.com.cn
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
refresh_tokenstring | Mandatory The refresh_token obtained in the previous step |
client_idstring | Mandatory The Client ID that was generated during the client registration |
client_secretstring | Mandatory The Client Secret that was generated during the client registration |
redirect_uristring | Optional One of the Authorized Redirect URIs you provided while registering the client in the previous step. You must not provide an unregistered redirect URI. |
grant_typestring | Mandatory refresh_token (Provide this literal string as the value) |
Example Request
POST https://accounts.zoho.com/oauth/v2/token?refresh_token={refresh_token}&client_secret={client_secret}&grant_type=refresh_token&client_id={client_id}
Example Response
{ access_token: "1000.a*********************b.2**************************e", token_type: "Bearer", expires_in: 3600 }
Revoke Refresh Token
To revoke the refresh token, which generated and presist for future use
Note:
You must use your domain-specific Zoho Accounts URL to revoke your refresh token.
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
tokenstring | The refresh_token obtained in the Generate Access and Refresh Token api |
Example Request
POST https://accounts.zoho.com/oauth/v2/token?token={refresh_token}
Token Validity
Grant Token (Authorization code)
- Grant token is a one-time use token and valid for two minutes by default. If you want to extend the expiry time, choose the required time from the drop-down while generating the token from the developer console (applicable only to self-clients).
- You can generate a maximum of 10 grant tokens in a span of 10 minutes per client ID.
Access Token
- Each access token is valid for one hour.
- You can generate a maximum of 10 access tokens in a span of 10 minutes.
- When you generate the 11th access token, the first created access token will be deleted.
Refresh Token
- Refresh tokens do not expire until a user revokes them.
- You can generate a maximum of 10 access tokens from a refresh token in a span of 10 minutes.
- You can generate a maximum of 20 refresh tokens in a span of 10 minutes per client ID.
- When you generate the 21st refresh token, the first created refresh token gets deleted.
Getting started
Zoho WorkDrive is composed of the following entities, and you'll need to be familiar with these entities to access and use APIs. WorkDrive APIs follow REST API standards and support HTTP requests and responses for accessing WorkDrive entities. WorkDrive entities are exposed through their endpoint URLs, and the HTTP clients can access these endpoints using their specific APIs. All inputs and responses are in the JSON API format. All responses will have an HTTP status code.
Entities | Type | Description |
Users | users | A standard representation of someone who uses and operates WorkDrive. |
Team | teams | The company or organization where all members and their data are added. |
Team Members | users | A user who is part of your team in WorkDrive. |
Current user | users | The current user. |
Team Folders | teamfolders | A set of team folders inside a team. |
Team Folder Members | members | A set of members added into the team folders inside a team. |
Groups | groups | Organize members of your team into groups. |
Files/Folders | files | A logical organization of files/folders within a team folder. |
My Folders | privatespace | An exclusive space where a user can create, upload, and share their own files. |
Links | links | Share a file or folder externally with custom share links. |
HTTP Request Methods
All Zoho WorkDrive APIs follow REST standards (i.e., they use the HTTP request methods such as GET, POST, PATCH, DELETE, etc).
The following table describes the purpose of these HTTP methods:
Method | Description |
GET | To retrieve resources. |
POST | To insert or upload any new resource. |
PATCH | To update a specific detail of the resource. This method updates the target resource with the provided content without changing other data. |
DELETE | To delete a resource. |
Http Status Code
When the server encounters an error while processing a client request, it sends the appropriate HTTP Status Code back to the client in response. WorkDrive will recognize the following status codes:
Http Status Code | Message | Description |
200 | OK | The API request is successful. |
201 | Created | Request for record insertion fulfilled. |
204 | No Content | There is no content available for the request. |
400 | Bad Request | The request or the authentication considered is invalid. |
401 | Unauthorized Access | No permission to do the operation. |
402 | Payment Required | License has expired. |
404 | Not Found | Invalid request. |
405 | Method Not Allowed | The specified method is not allowed. |
415 | Unsupported Media Type | The server did not accept the request while uploading a file since the media/file type is not supported. |
422 | Unprocessable Entity | The given inputs are unable to process the particular action. |
500 | General Exception | Generic error encountered due to an unexpected server error. |
Request and Response Structure
Zoho WorkDrive's APIs follow JSON:API specification, which is a powerful method of communication between client and server with well-structured request and response formatting. Besides responses, JSON:API also covers creating, updating, and deleting resources and offers features like filtering, pagination, sparse field sets, great error formatting, etc. Click here to learn more about JSON API specifications. As mentioned, all entities are exposed as JSON:API resources using the structure as follows:
{
"data":,
{
"type": "type",
"id": "identifier",
"attributes": "{....}",
"relationships": "{....}",
},
"links":{....},
"meta":{....}
}
JSON:API responses are composed inside the "data" key. This "data" key consists of five sections:
- Identifier keys: These identify the "type" and "ID" of an entity. These two keys uniquely identify the entity.
- attributes: This describes actual entity properties such as name, kind, created time, etc.
- relationships: This describes relationships between the current entity and other entities within WorkDrive.
- links: This is used to access related entities.
- meta: This provides additional information about entities to support meaningful interactions with the end-user.
Encode Query Parameter
In the WorkDrive API request, Query parameter name should be URL encoded with UTF-8 Charset.
For example, If a request has query string parameters filter[type], then a left square bracket [ must be replaced by %5B and a right square bracket slash ] must be replaced by %5D. so filter[type] query parameter in the API URL must be encoded as filter%5Btype%5D.
Pagination
To navigate multiple pages, WorkDrive provides two options. They are offset-based pagination and cursor-based pagination.
Offset Pagination
Offset pagination is used to limit the number of items returned in a response of a fixed and predetermined length. Without specifying any pagination parameter, Listing APIs usually return 50 items by default, which is the allowed maximum limit.
If you need to fetch results with user-defined numbers, you must specify the query string parameters as ?page[offset]=0&page[limit]=50, where the offset is the starting value and the limit is the number of items needed in response.
When listing files and folders, if the total count of items is equal to the default limit, it is necessary to make multiple API calls to retrieve all items. If a folder has 200 files, you should call APIs iteratively with pagination parameters as follows:
- page[offset]=0&page[limit]=50
- page[offset]=50&page[limit]=50
- page[offset]=100&page[limit]=50
- page[offset]=150&page[limit]=50
Cursor Pagination
Cursor pagination is used to get a large volume of items in the API response, and you will be able to jump to any particular page. For the initial request, you must specify the query string parameter as ?page[next]=0&page[limit]=1000, where next is the token for a page and the limit is the number of items needed in response. The next page token will be sent in the API response.
links: {
cursor: {
has_next: true,
next: "https://workdrive.zoho.com/workdrive/api/v1/privatespace/ipcpn1aad4e50d6f040be9690501bc5166341/files?page[next]=55019b03582d7"
}
}
In the second request, use the URL provided in the next field until has_next becomes false. The has_next indicates whether the next page is available or not. The links object is located below the data object. Listing APIs usually return 1000 items by default if you invoke API call from OAuth token, which is the maximum allowed limit.
In offset pagination, you can jump to any page. For example, from the 6th page, you can jump to the 10th page. But in cursor pagination, you can only go to the next or previous page. Also, if you lose the next page URL, you won't be able to go the next page.
Note: In cursor pagination, listed items won't follow the folder-first approach.
Request Header
Data APIs (JSON:API media type)
WorkDrive follows JSON:API specifications. We highly recommend sending every request with the following header to represent the content type of the JSON:API data in the request body:
Accept: application/vnd.api+json
Servers must respond with a 415 Unsupported Media Type status code if any request does not specify the header Accept: application/vnd.api+json.
File Content Upload APIs
To upload data that is less than 250 MB in size, we recommend you use this API: Upload File. For content larger than 250 MB, use the Upload Large File.
In both cases, the user should call both upload endpoints with the Content-Type: multipart/form-data, and binary data content should be sent as form data.
File Content Download APIs
File Content Download APIs should be used through download.zoho.com to download the binary content of the file in WorkDrive.
Multi DC Support
Zoho WorkDrive is hosted in multiple datacenters across the globe, and the API domain URL varies for each datacenter.
Here is a table that outlines where Zoho WorkDrive stores the data in the available datacenters and their corresponding domains. For instance, people who access Zoho via the .IN domain will be on the India data center.
Data Center | Domain | Base API URI |
United States of America | .com | https://www.zohoapis.com/workdrive/ |
European Union | .eu | https://www.zohoapis.eu/workdrive/ |
India | .in | https://www.zohoapis.in/workdrive/ |
Australia | .com.au | https://www.zohoapis.com.au/workdrive/ |
China | .com.cn | https://www.zohoapis.com.cn/workdrive/ |
To find out which domain you're accessing Zoho WorkDrive from, visit the Zoho Workdrive web app and check its URL.
If your WorkDrive URL is workdrive.zoho.com, then you can use https://www.zohoapis.com/workdrive/ as your base API URL.
Similarly, based on your WorkDrive URL, you have to use the corresponding base API URL given above in the table.
Fetching IDs
myfolder_id : Unique ID that represents a team member's my folders. A myfolder_id is created when a user is added to a WorkDrive team.
team_member_id : Unique ID that represents the team member. The team_member_id is created when a user becomes part of a team.
Get Current User's My Folders ID
You should call the following three APIs consecutively to get myfolder_id of the current user.
Step 1: Get a list of all teams the current user belongs to using the Get All Teams of User API.
Step 2: Get the team_member_id of the current user using the Get Current Team Member API.
Step 3: Now, you can get the myfolder_id of the team member of a specified team using the Get My Folders Id API.
Filters
You can filter the GET endpoints responses for TeamFolders, Files, Actions, Links, and Groups using the filter query string parameter.
Filtering follows the following format:
?filter[{fieldname}]={value}
Here, the fieldname can be a type, name, ID, or any of the resource's attributes or metadata, and the value is the value you are filtering against. Depending on the endpoint, you can apply a filter.
For example, To filter the image files from the folder should be given as follows filter[type]=images.
File Filter
Name | Description |
all | To retrieve all available resources. |
allfiles | To retrieve all files. |
documents | Filters the result to retrieve only document files. |
spreadsheets | Filters the result to retrieve only spreadsheet files. |
presentations | Filters the result to retrieve only presentation files. |
Filters the result to retrieve only pdf files. | |
audio | Filters the result to retrieve only audio files. |
video | Filters the result to retrieve only video files. |
images | Filters the result to retrieve only image files. |
folder | To retrieve all folders. |
mydrafts | To retrieve all files and folders in draft status. |
documents_native | To narrow down the results to fetch only the native (Zoho Writer) document files. |
spreadsheets_native | To narrow down the results to fetch only the native (Zoho Sheet) spreadsheet files. |
presentations_native | To narrow down the results to fetch only the native (Zoho Show) presentation files. |
documents_non_native | To narrow down the results to fetch only the non-native document files. |
spreadsheets_non_native | To narrow down the results to fetch only the non-native spreadsheet files. |
presentations_non_native | To narrow down the results to fetch only the non-native presentation files. |
TeamFolder Filter
Name | Description |
userjoinedws | To retrieve all team folders the user belongs to. |
Action Filter
Action ID | Action |
0 | Read / Preview |
1 | Download |
101 | Upload |
102 | Create |
103 | Edit |
501 | Share |
503 | Unshare |
Link Filter
Type | Description |
custom | To retrieve links shared with customized properties. |
download | To retrieve all download-enabled links. |
Group Filter
Type ID | Group Name |
1 | WorkDrive Group. |
2 | ZohoOne Group. |
Users
A standard representation of users who uses and operates WorkDrive.
Get User Info
This API fetches information about the user. Returns user pieces of information like name, email, zohouserid(Zuid), and WorkDrive edition currently the user is on.
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/users/me
Example Response
{ data: { id: "747938014", type: "users", attributes: { email_id: "zylker@zylker.com", member_type: 1, theme_color: "28B294", getting_started: 1, is_org_template_admin: true, favoritedfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, default_view_type: 2, view_pref: { sort_by: "last_modified", sort_order: "desc", layout: "list" }, edition: "TEAM", unread_count_myspace: 0, storage_info: { size: "181.0 KB", storage_used: "256.0 KB", files_count: 2, folders_count: 1, size_in_bytes: 185368, storage_used_in_bytes: 262225 }, mig_status: 0, last_login_time_in_millisecond: 0, files_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, invited_time: 1618243925174, user_type: 1, labeledfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, zid: "747938014", role_id: 32, preferred_view: "TEAM", is_sync_enabled: true, has_myfolder: true, last_accessed_library: "", is_mobile_enabled: true, last_accessed_folder: "", enable_myspace_restriction_all: false, connected_devices: 0, outgoingfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, capabilities: { can_access_myfolder: true, can_have_org_templates: true, can_sync: true, can_create_team: false }, incomingfiles_view_pref: { sort_by: "shared_time", sort_order: "desc", filtered_by: "all", layout: "list" }, app_names: [], is_personal_exist: false, preferred_team_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", display_name: "Zylker Creation", zuid: "747938014", trashedfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, avatar_url: "https://contacts.zoho.com/file?t=user&ID=747938014&fs=thumb&nps=404", allowed_myspace_storage: -1, org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", is_unread_myspace: false, invited_time_i18: "Apr 12, 9:42 PM", zid_type: 262144, status: "ACTIVE" }, relationships: { privatespace: { links: { self: "https://www.zohoapis.com/workdrive/users/747938014/relationships/privatespace", related: "https://www.zohoapis.com/workdrive/users/747938014/privatespace" } }, teams: { links: { self: "https://www.zohoapis.com/workdrive/users/747938014/relationships/teams", related: "https://www.zohoapis.com/workdrive/users/747938014/teams" } }, devices: { links: { self: "https://www.zohoapis.com/workdrive/users/747938014/relationships/devices", related: "https://www.zohoapis.com/workdrive/users/747938014/devices" } }, records: { links: { self: "https://www.zohoapis.com/workdrive/users/747938014/relationships/records", related: "https://www.zohoapis.com/workdrive/users/747938014/records" } }, enterprise: { links: { self: "https://www.zohoapis.com/workdrive/users/747938014/relationships/enterprise", related: "https://www.zohoapis.com/workdrive/users/747938014/enterprise" } }, incomingfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/747938014/relationships/incomingfiles", related: "https://www.zohoapis.com/workdrive/users/747938014/incomingfiles" } }, libraries: { links: { self: "https://www.zohoapis.com/workdrive/users/747938014/relationships/libraries", related: "https://www.zohoapis.com/workdrive/users/747938014/libraries" } }, favoritedfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/747938014/relationships/favoritedfiles", related: "https://www.zohoapis.com/workdrive/users/747938014/favoritedfiles" } }, groups: { links: { self: "https://www.zohoapis.com/workdrive/users/747938014/relationships/groups", related: "https://www.zohoapis.com/workdrive/users/747938014/groups" } }, labels: { links: { self: "https://www.zohoapis.com/workdrive/users/747938014/relationships/labels", related: "https://www.zohoapis.com/workdrive/users/747938014/labels" } }, recentfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/747938014/relationships/recentfiles", related: "https://www.zohoapis.com/workdrive/users/747938014/recentfiles" } }, license: { links: { self: "https://www.zohoapis.com/workdrive/users/747938014/relationships/license", related: "https://www.zohoapis.com/workdrive/users/747938014/license" } }, recordsuggestions: { links: { self: "https://www.zohoapis.com/workdrive/users/747938014/relationships/recordsuggestions", related: "https://www.zohoapis.com/workdrive/users/747938014/recordsuggestions" } }, organization: { links: { self: "https://www.zohoapis.com/workdrive/users/747938014/relationships/organization", related: "https://www.zohoapis.com/workdrive/users/747938014/organization" } }, collaborators: { links: { self: "https://www.zohoapis.com/workdrive/users/747938014/relationships/collaborators", related: "https://www.zohoapis.com/workdrive/users/747938014/collaborators" } }, labeledfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/747938014/relationships/labeledfiles", related: "https://www.zohoapis.com/workdrive/users/747938014/labeledfiles" } }, incomingfolders: { links: { self: "https://www.zohoapis.com/workdrive/users/747938014/relationships/incomingfolders", related: "https://www.zohoapis.com/workdrive/users/747938014/incomingfolders" } }, workspaces: { links: { self: "https://www.zohoapis.com/workdrive/users/747938014/relationships/workspaces", related: "https://www.zohoapis.com/workdrive/users/747938014/workspaces" } }, unreadfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/747938014/relationships/unreadfiles", related: "https://www.zohoapis.com/workdrive/users/747938014/unreadfiles" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/users/747938014/relationships/tasks", related: "https://www.zohoapis.com/workdrive/users/747938014/tasks" } }, notifications: { links: { self: "https://www.zohoapis.com/workdrive/users/747938014/relationships/notifications", related: "https://www.zohoapis.com/workdrive/users/747938014/notifications" } }, contacts: { links: { self: "https://www.zohoapis.com/workdrive/users/747938014/relationships/contacts", related: "https://www.zohoapis.com/workdrive/users/747938014/contacts" } }, apps: { links: { self: "https://www.zohoapis.com/workdrive/users/747938014/relationships/apps", related: "https://www.zohoapis.com/workdrive/users/747938014/apps" } } }, links: { self: "https://www.zohoapis.com/workdrive/users/747938014" } } }
Show fullGet All Teams of User
This API returns a list of teams of the user.
Path Parameters
zuidstring | Mandatory The unique ID that represents the current user. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/users/{zuid}/teams
Example Response
{ data: { id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", type: "teams", attributes: { modified_time_i18: "Apr12,9:42PM", member_type: 1, plan_type: 0, link_start_characters: "OCgNc", color: "#B5CC18", description: "", storage_info: { size: "5.18MB", storage_used: "5.18MB", files_count: 5, folders_count: 0, size_in_bytes: 5426572, storage_used_in_bytes: 5426572 }, is_discoverable: false, is_current_user_admin: true, created_time_i18: "Apr12,9:42PM", unread_count: 0, modified_time_in_millisecond: 1618243925136, modified_time: "Apr12,9:42PM", is_preferred: true, role_id: 32, member_status: 1, is_integrated_with_app: false, logo: {}, shared_status: "ACTIVE", created_time_in_millisecond: 1618243925136, superadmin_contact: "zylker@zylker.com", is_last_viewed: true, owner: "747937818", created_time: "Apr12,9:42PM", capabilities: { can_read: true, can_delete: true, can_edit: true, can_add_member: true, can_create_private_workspace: true, can_create_workspace: true, can_create_public_workspace: true, can_browse_workspace: true, can_manage_label: true, can_manage_task: true }, is_guest_user: false, watch_notification_count: 0, is_directory_enabled: false, invited_by: "Zylker Creation", notification_count: 0, is_partof: true, created_by: "Zylker Creation", license_status: 0, enable_myspace_storage_restriction: false, created_by_zuid: "747938014", product_type: 1, user_count: 1, license_obj: { purchased_for: 0, purchased_by: 0, policyinfo_id: 0, start_date: 0, billing_date: 0, allowed_space: 0, allowed_space_bytes: 0, bundle_id: 0, additional_storage: 0, remaining_license_users: 0, remaining_guest_users: 0, allowed_external_link_creation: 0, external_shared_to_users_limit: 0 }, parent_id: "-1", is_unread: false, name: "Zylker Creation", is_new_notification: false, is_current_user_super_admin: true }, relationships: { currentuser: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/currentuser", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/currentuser" } }, settings: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/settings", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/settings" } }, installapps: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/installapps", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/installapps" } }, records: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/records", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/records" } }, libraries: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/libraries", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/libraries" } }, groups: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/groups", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/groups" } }, users: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/users", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/users" } }, accesschartdata: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/accesschartdata", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/accesschartdata" } }, license: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/license", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/license" } }, install: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/install", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/install" } }, recordsuggestions: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/recordsuggestions", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/recordsuggestions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/timeline", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/timeline" } }, workspaces: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/workspaces", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/workspaces" } }, datatemplates: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/datatemplates", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/datatemplates" } }, apps: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/apps", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/apps" } } }, links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763" } } }
Show fullTeam Members
Team members are users who have been part of your team in WorkDrive. There will be one super admin in a team, and other team members can either have team admin or team member roles.
Get Team Member Info
This API fetches information about a team member.
Path Parameters
team_member_idstring | Mandatory The unique ID of the team member that is created when a member is added into a team. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/users/{team_member_id}
Example Response
{ data: { id: "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001", type: "users", attributes: { email_id: "reyansh.ahuja@zylker.com", member_type: 1, theme_color: "28B294", getting_started: 1, is_org_template_admin: true, favoritedfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, default_view_type: 2, view_pref: { sort_by: "last_modified", sort_order: "desc", layout: "list" }, edition: "TEAM", unread_count_myspace: 0, storage_info: { size: "231.0 KB", storage_used: "231.0 KB", files_count: 3, folders_count: 0, size_in_bytes: 237192, storage_used_in_bytes: 237192 }, mig_status: 0, last_login_time_in_millisecond: 0, files_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, invited_time: 1618243925174, user_type: 1, labeledfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, role_id: 32, preferred_view: "TEAM", is_sync_enabled: true, has_myfolder: true, last_accessed_library: "", is_mobile_enabled: true, last_accessed_folder: "", enable_myspace_restriction_all: false, connected_devices: 0, outgoingfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, capabilities: { can_access_myfolder: true, can_have_org_templates: true, can_sync: true, can_create_team: false }, incomingfiles_view_pref: { sort_by: "shared_time", sort_order: "desc", filtered_by: "all", layout: "list" }, app_names: [], is_personal_exist: false, display_name: "Zylker Creation", zuid: "747938014", trashedfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, avatar_url: "https://contacts.zoho.com/file?t=user&ID=747938014&fs=thumb&nps=404", allowed_myspace_storage: -1, is_unread_myspace: false, invited_time_i18: "Apr 12, 9:42 PM", zid_type: 262144, status: "ACTIVE" }, relationships: { privatespace: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/privatespace", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/privatespace" } }, teams: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/teams", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/teams" } }, devices: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/devices", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/devices" } }, records: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/records", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/records" } }, enterprise: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/enterprise", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/enterprise" } }, incomingfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/incomingfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/incomingfiles" } }, libraries: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/libraries", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/libraries" } }, favoritedfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/favoritedfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/favoritedfiles" } }, groups: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/groups", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/groups" } }, labels: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/labels", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/labels" } }, recentfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/recentfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/recentfiles" } }, license: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/license", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/license" } }, recordsuggestions: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/recordsuggestions", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/recordsuggestions" } }, organization: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/organization", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/organization" } }, collaborators: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/collaborators", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/collaborators" } }, labeledfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/labeledfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/labeledfiles" } }, incomingfolders: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/incomingfolders", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/incomingfolders" } }, workspaces: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/workspaces", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/workspaces" } }, unreadfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/unreadfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/unreadfiles" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/tasks", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/tasks" } }, notifications: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/notifications", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/notifications" } }, contacts: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/contacts", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/contacts" } }, apps: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/apps", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/apps" } } }, links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001" } } }
Show fullGet Team Member's Groups
This API lists all the groups a specific team member is part of.
Path Parameters
team_member_idstring | Mandatory The unique ID of the team member that is created when a member is added into a team. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/users/{team_member_id}/groups
Example Response
{ data: [ { id: "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021", type: "groups", attributes: { owner: "747937818", created_time: "Apr 13, 12:15 AM", capabilities: { can_read: true, can_delete: true, can_edit: true, can_trash: true, can_rename: true, can_restore: true, can_add_members: true }, description: "", type: 1, created_by: "Zylker Creation", modified_time: "Apr 13, 12:15 AM", avatar_url: "https://js.zohostatic.com/personal/stable/jsapps/ui-lab/dist/assets/dev/svg-icons/common/groups_logo-1b99e1d06fa5e3bb404e335e6ce2f43a.svg", parent_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", name: "Managers", modified_by: "Zylker Creation", members_count: 1, status: 1 }, relationships: { groupmembers: { links: { self: "https://www.zohoapis.com/workdrive/groups/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021/relationships/groupmembers", related: "https://www.zohoapis.com/workdrive/groups/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021/groupmembers" } } }, links: { self: "https://www.zohoapis.com/workdrive/groups/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021" } } ] }
Show fullGet Team Member Collaborators
This API fetches the list of all team members and groups with whom the user has shared files and folders.
Path Parameters
team_member_idstring | Mandatory The unique ID of the team member that is created when a member is added into a team. |
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
filter[sharedtype]string |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/users/{team_member_id}/collaborators
Example Response
{ data: [ { id: "747938058", type: "collaborators", attributes: { email_id: "reyansh.ahuja@zylker.com", avatar_url: "https://contacts.zoho.com/file?t=user&ID=747938058&fs=thumb", name: "Zylker Creation", type: 3 }, links: { self: "https://www.zohoapis.com/workdrive/collaborators/747938058" } } ] }
Invite New Member to Team
This API is used to invite one or more new members to a team in WorkDrive.
Note:
Only Team Admins and the Super Admin can invite new members to a team.
Request Body Parameters
email_idstring | MandatoryThe valid email addresses of the users to whom the invites will be sent. |
category_idstring | MandatoryThe unique ID of the team. |
role_idinteger | Mandatory Allowed values for role id:
|
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/users
{ data: [ { attributes: { email_id: "reyansh.ahuja@zylker.com", category_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", role_id: "30" }, type: "users" }, { attributes: { email_id: "ryan.west@zylker.com", category_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", role_id: "30" }, type: "users" } ] }
Example Response
{ data: [ { id: "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012", type: "users", attributes: { member_type: 1, theme_color: "28B294", getting_started: 0, is_org_template_admin: false, favoritedfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, default_view_type: 2, view_pref: { sort_by: "last_modified", sort_order: "desc", layout: "list" }, edition: "TEAM", unread_count_myspace: 0, mig_status: 0, last_login_time_in_millisecond: 0, files_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, invited_time: 1618249438092, user_type: 0, labeledfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, role_id: 30, is_sync_enabled: true, has_myfolder: true, last_accessed_library: "", is_mobile_enabled: true, last_accessed_folder: "", enable_myspace_restriction_all: false, connected_devices: 0, outgoingfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, capabilities: { can_access_myfolder: true, can_have_org_templates: true, can_sync: true, can_create_team: true }, incomingfiles_view_pref: { sort_by: "shared_time", sort_order: "desc", filtered_by: "all", layout: "list" }, app_names: [], display_name: "Zylker Creation", zuid: "747938058", trashedfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, reinvite: false, avatar_url: "https://contacts.zoho.com/file?t=user&ID=747938058&fs=thumb&nps=404", allowed_myspace_storage: -1, is_unread_myspace: false, invited_time_i18: "Apr 12, 11:13 PM", zid_type: 262144, status: "INVITED" }, relationships: { privatespace: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/privatespace", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/privatespace" } }, teams: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/teams", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/teams" } }, devices: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/devices", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/devices" } }, records: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/records", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/records" } }, enterprise: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/enterprise", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/enterprise" } }, incomingfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/incomingfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/incomingfiles" } }, libraries: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/libraries", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/libraries" } }, favoritedfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/favoritedfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/favoritedfiles" } }, groups: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/groups", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/groups" } }, labels: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/labels", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/labels" } }, recentfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/recentfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/recentfiles" } }, license: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/license", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/license" } }, recordsuggestions: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/recordsuggestions", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/recordsuggestions" } }, organization: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/organization", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/organization" } }, collaborators: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/collaborators", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/collaborators" } }, labeledfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/labeledfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/labeledfiles" } }, incomingfolders: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/incomingfolders", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/incomingfolders" } }, workspaces: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/workspaces", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/workspaces" } }, unreadfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/unreadfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/unreadfiles" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/tasks", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/tasks" } }, notifications: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/notifications", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/notifications" } }, contacts: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/contacts", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/contacts" } }, apps: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/apps", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/apps" } } }, links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012" } }, { id: "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013", type: "users", attributes: { member_type: 1, theme_color: "28B294", getting_started: 0, is_org_template_admin: false, favoritedfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, default_view_type: 2, view_pref: { sort_by: "last_modified", sort_order: "desc", layout: "list" }, edition: "TEAM", unread_count_myspace: 0, mig_status: 0, last_login_time_in_millisecond: 0, files_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, invited_time: 1618249438093, user_type: 0, labeledfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, role_id: 30, is_sync_enabled: true, has_myfolder: true, last_accessed_library: "", is_mobile_enabled: true, last_accessed_folder: "", enable_myspace_restriction_all: false, connected_devices: 0, outgoingfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, capabilities: { can_access_myfolder: true, can_have_org_templates: true, can_sync: true, can_create_team: true }, incomingfiles_view_pref: { sort_by: "shared_time", sort_order: "desc", filtered_by: "all", layout: "list" }, app_names: [], display_name: "Zylker Creation", zuid: "747938123", trashedfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, reinvite: false, avatar_url: "https://contacts.zoho.com/file?t=user&ID=747938123&fs=thumb&nps=404", allowed_myspace_storage: -1, is_unread_myspace: false, invited_time_i18: "Apr 12, 11:13 PM", zid_type: 262144, status: "INVITED" }, relationships: { privatespace: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/privatespace", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/privatespace" } }, teams: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/teams", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/teams" } }, devices: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/devices", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/devices" } }, records: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/records", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/records" } }, enterprise: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/enterprise", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/enterprise" } }, incomingfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/incomingfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/incomingfiles" } }, libraries: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/libraries", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/libraries" } }, favoritedfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/favoritedfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/favoritedfiles" } }, groups: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/groups", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/groups" } }, labels: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/labels", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/labels" } }, recentfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/recentfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/recentfiles" } }, license: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/license", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/license" } }, recordsuggestions: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/recordsuggestions", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/recordsuggestions" } }, organization: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/organization", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/organization" } }, collaborators: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/collaborators", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/collaborators" } }, labeledfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/labeledfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/labeledfiles" } }, incomingfolders: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/incomingfolders", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/incomingfolders" } }, workspaces: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/workspaces", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/workspaces" } }, unreadfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/unreadfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/unreadfiles" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/tasks", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/tasks" } }, notifications: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/notifications", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/notifications" } }, contacts: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/contacts", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/contacts" } }, apps: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/apps", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/apps" } } }, links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013" } } ] }
Show fullChange Team Member's role
This API will change a team member's role in a team.
Note:
Only Team Admins can change a team member's role in the team.
Path Parameters
team_member_idstring | Mandatory The unique ID of a team member whose role needs to be changed. |
Request Body Parameters
role_idinteger | Mandatory Allowed values for role id:
|
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/users/{team_member_id}
{ data: { attributes: { role_id: "31" }, type: "users" } }
Example Response
{ data: { id: "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012", type: "users", attributes: { email_id: "reyansh.ahuja@zylker.com", member_type: 1, theme_color: "28B294", getting_started: 1, is_org_template_admin: true, favoritedfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, default_view_type: 2, view_pref: { sort_by: "last_modified", sort_order: "desc", layout: "list" }, edition: "TEAM", unread_count_myspace: 0, storage_info: { size: "92.0 KB", storage_used: "92.0 KB", files_count: 1, folders_count: 0, size_in_bytes: 94427, storage_used_in_bytes: 94427 }, mig_status: 0, last_login_time_in_millisecond: 0, files_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, invited_time: 1618250069143, user_type: 1, labeledfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, role_id: 31, preferred_view: "TEAM", is_sync_enabled: true, has_myfolder: true, last_accessed_library: "", is_mobile_enabled: true, last_accessed_folder: "", enable_myspace_restriction_all: false, connected_devices: 0, outgoingfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, capabilities: { can_access_myfolder: true, can_have_org_templates: true, can_sync: true, can_create_team: false }, incomingfiles_view_pref: { sort_by: "shared_time", sort_order: "desc", filtered_by: "all", layout: "list" }, app_names: [], is_personal_exist: false, display_name: "Zylker Creation", zuid: "747938058", trashedfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, avatar_url: "https://contacts.zoho.com/file?t=user&ID=747938058&fs=thumb&nps=404", allowed_myspace_storage: -1, is_unread_myspace: false, invited_time_i18: "Apr 12, 11:24 PM", zid_type: 262144, status: "ACTIVE" }, relationships: { privatespace: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/privatespace", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/privatespace" } }, teams: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/teams", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/teams" } }, devices: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/devices", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/devices" } }, records: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/records", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/records" } }, enterprise: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/enterprise", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/enterprise" } }, incomingfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/incomingfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/incomingfiles" } }, libraries: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/libraries", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/libraries" } }, favoritedfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/favoritedfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/favoritedfiles" } }, groups: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/groups", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/groups" } }, labels: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/labels", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/labels" } }, recentfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/recentfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/recentfiles" } }, license: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/license", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/license" } }, recordsuggestions: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/recordsuggestions", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/recordsuggestions" } }, organization: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/organization", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/organization" } }, collaborators: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/collaborators", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/collaborators" } }, labeledfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/labeledfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/labeledfiles" } }, incomingfolders: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/incomingfolders", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/incomingfolders" } }, workspaces: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/workspaces", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/workspaces" } }, unreadfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/unreadfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/unreadfiles" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/tasks", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/tasks" } }, notifications: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/notifications", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/notifications" } }, contacts: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/contacts", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/contacts" } }, apps: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/apps", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/apps" } } }, links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012" } } }
Show fullSuspend Team Member
This API helps in suspending a team member temporarily from a team. Learn more.
Note:
Only Team Admins can suspend a team member from the team.
Information:
- A suspended member will immediately lose access to the team account and any synced files.
- Files and folders uploaded or created by the member will remain active.
- The user license of a suspended member will be canceled. The admin can either re-use it for a new member or reimburse the license.
- Once the member is activated and removed from the suspension, they can resume all activities and regain access to all their files.
Path Parameters
team_member_idstring | Mandatory The unique ID of a team member who will be suspended from the team. |
Request Body Parameters
statusstring | Mandatory Set as "SUSPENDED". |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/users/{team_member_id}
{ data: { attributes: { status: "SUSPENDED" }, type: "users" } }
Example Response
{ data: { id: "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012", type: "users", attributes: { email_id: "reyansh.ahuja@zylker.com", member_type: 1, theme_color: "28B294", getting_started: 1, is_org_template_admin: true, favoritedfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, default_view_type: 2, view_pref: { sort_by: "last_modified", sort_order: "desc", layout: "list" }, edition: "TEAM", unread_count_myspace: 0, storage_info: { size: "92.0 KB", storage_used: "92.0 KB", files_count: 1, folders_count: 0, size_in_bytes: 94427, storage_used_in_bytes: 94427 }, mig_status: 0, last_login_time_in_millisecond: 0, files_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, invited_time: 1618250069143, user_type: 1, labeledfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, role_id: 31, preferred_view: "TEAM", is_sync_enabled: true, has_myfolder: true, last_accessed_library: "", is_mobile_enabled: true, last_accessed_folder: "", enable_myspace_restriction_all: false, connected_devices: 0, outgoingfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, capabilities: { can_access_myfolder: true, can_have_org_templates: true, can_sync: true, can_create_team: true }, incomingfiles_view_pref: { sort_by: "shared_time", sort_order: "desc", filtered_by: "all", layout: "list" }, app_names: [], is_personal_exist: false, display_name: "Zylker Creation", zuid: "747938058", trashedfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, avatar_url: "https://contacts.zoho.com/file?t=user&ID=747938058&fs=thumb&nps=404", allowed_myspace_storage: -1, is_unread_myspace: false, invited_time_i18: "Apr 12, 11:24 PM", zid_type: 262144, status: "SUSPENDED" }, relationships: { privatespace: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/privatespace", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/privatespace" } }, teams: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/teams", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/teams" } }, devices: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/devices", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/devices" } }, records: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/records", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/records" } }, enterprise: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/enterprise", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/enterprise" } }, incomingfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/incomingfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/incomingfiles" } }, libraries: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/libraries", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/libraries" } }, favoritedfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/favoritedfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/favoritedfiles" } }, groups: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/groups", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/groups" } }, labels: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/labels", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/labels" } }, recentfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/recentfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/recentfiles" } }, license: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/license", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/license" } }, recordsuggestions: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/recordsuggestions", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/recordsuggestions" } }, organization: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/organization", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/organization" } }, collaborators: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/collaborators", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/collaborators" } }, labeledfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/labeledfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/labeledfiles" } }, incomingfolders: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/incomingfolders", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/incomingfolders" } }, workspaces: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/workspaces", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/workspaces" } }, unreadfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/unreadfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/unreadfiles" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/tasks", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/tasks" } }, notifications: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/notifications", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/notifications" } }, contacts: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/contacts", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/contacts" } }, apps: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/apps", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/apps" } } }, links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012" } } }
Show fullDelete Team Member
This API deletes a team member from a team. When you delete a team member, you should transfer their data to another active team member.
Learn more.
Which data will be transferred:
Note:
Only Team admins can delete a team member from the team.
Path Parameters
team_member_idstring | Mandatory The unique of a team member who will be deleted from the team. |
Request Body Parameters
statusstring | Mandatory Set as "DELETED". |
ownership_transfer_idstring | Mandatory The unique ID of the team member to whom the deleted team member's data need to be migrated. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/users/{team_member_id}
{ data: { attributes: { status: "DELETED", ownership_transfer_id: "zylker@zylker.com" }, type: "users" } }
Example Response
{ data: { id: "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012", type: "users", attributes: { email_id: "reyansh.ahuja@zylker.com", member_type: 1, theme_color: "28B294", getting_started: 1, is_org_template_admin: true, favoritedfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, default_view_type: 2, view_pref: { sort_by: "last_modified", sort_order: "desc", layout: "list" }, edition: "TEAM", unread_count_myspace: 0, mig_status: 0, last_login_time_in_millisecond: 0, files_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, invited_time: 1618250069143, user_type: 1, labeledfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, role_id: 31, preferred_view: "TEAM", is_sync_enabled: true, has_myfolder: true, last_accessed_library: "", is_mobile_enabled: true, last_accessed_folder: "", enable_myspace_restriction_all: false, connected_devices: 0, outgoingfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, capabilities: { can_access_myfolder: true, can_have_org_templates: true, can_sync: true, can_create_team: true }, incomingfiles_view_pref: { sort_by: "shared_time", sort_order: "desc", filtered_by: "all", layout: "list" }, app_names: [], is_personal_exist: false, display_name: "Zylker Creation", zuid: "747938058", trashedfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, transfer_ownership_information: { status: 3 }, avatar_url: "https://contacts.zoho.com/file?t=user&ID=747938058&fs=thumb&nps=404", allowed_myspace_storage: -1, can_transfer_ownership: true, is_unread_myspace: false, invited_time_i18: "Apr 12, 11:24 PM", zid_type: 262144, status: "DELETED" }, relationships: { privatespace: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/privatespace", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/privatespace" } }, teams: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/teams", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/teams" } }, devices: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/devices", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/devices" } }, records: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/records", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/records" } }, enterprise: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/enterprise", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/enterprise" } }, incomingfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/incomingfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/incomingfiles" } }, libraries: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/libraries", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/libraries" } }, favoritedfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/favoritedfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/favoritedfiles" } }, groups: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/groups", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/groups" } }, labels: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/labels", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/labels" } }, recentfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/recentfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/recentfiles" } }, license: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/license", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/license" } }, recordsuggestions: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/recordsuggestions", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/recordsuggestions" } }, organization: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/organization", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/organization" } }, collaborators: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/collaborators", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/collaborators" } }, labeledfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/labeledfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/labeledfiles" } }, incomingfolders: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/incomingfolders", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/incomingfolders" } }, workspaces: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/workspaces", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/workspaces" } }, unreadfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/unreadfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/unreadfiles" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/tasks", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/tasks" } }, notifications: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/notifications", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/notifications" } }, contacts: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/contacts", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/contacts" } }, apps: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/apps", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/apps" } } }, links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012" } } }
Show fullTeams
In Zoho WorkDrive, a team refers to the company or organization where all members and their data are added. A team is managed by the Super Admin and Team Admins. For Starter, Team, and Business plans of WorkDrive, there will be only one team.
Would you like to explore more about a team in WorkDrive? Visit our Help Center
Get Team Settings
This API fetches the settings of a specific team. For instance, this API will let the user know information about whether the team member is allowed to share files externally and able to create new public team folders.
Path Parameters
team_idstring | Mandatory The unique ID that represents a team. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/teams/{team_id}/settings
Example Response
{ data: { id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", type: "settings", attributes: { allow_external_sharing: true, create_file_as_draft: true, allow_my_folder_to_change_conversion: false, allow_create_private_team_folder: true, is_external_share_enabled: true, is_document_conversion: false, setting_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", trash_to_retention_days: 0, enable_myspace_storage_restriction: false, allow_ws_to_change_conversion: true, allow_embed_download: true, delete_to_purge_days: 0, is_app_retention_enabled: false, retention_service_type: 0, allow_create_ws: 0, is_sync_enabled: true, enable_org_logo: false, can_viewer_download: true, is_mobile_enabled: true }, links: { self: "https://www.zohoapis.com/workdrive/settings/ly9zmae16b43c258f458a9a57ac02c4f8d763" } } }
Show fullGet Groups in a Team
This API lists all the groups in a team.
Note:
Only Team Admins will be able to get a list of groups present in the team.
Path Parameters
team_idstring | Mandatory The unique ID of the team. |
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 Groups by type. |
page[limit]string | Optional Limit indicates the number of items to be listed. For More Details about pagination, refer here |
page[offset]string | Optional Offset indicates from where the listing should start. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/teams/{team_id}/groups?page%5Blimit%5D=50&page%5Boffset%5D=0
Example Response
{ data: [ { id: "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021", type: "groups", attributes: { owner: "747937818", created_time: "Apr 13, 12:15 AM", capabilities: { can_read: true, can_delete: true, can_edit: true, can_trash: true, can_rename: true, can_restore: true, can_add_members: true }, description: "", type: 1, created_by: "Zylker Creation", modified_time: "Apr 13, 12:15 AM", avatar_url: "https://js.zohostatic.com/personal/stable/jsapps/ui-lab/dist/assets/dev/svg-icons/common/groups_logo-1b99e1d06fa5e3bb404e335e6ce2f43a.svg", parent_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", name: "Managers", modified_by: "Zylker Creation", members_count: 1, status: 1 }, relationships: { groupmembers: { links: { self: "https://www.zohoapis.com/workdrive/groups/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021/relationships/groupmembers", related: "https://www.zohoapis.com/workdrive/groups/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021/groupmembers" } } }, links: { self: "https://www.zohoapis.com/workdrive/groups/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021" } } ] }
Show fullGet Team Info
This API fetches all details about a WorkDrive team.
Path Parameters
team_idstring | Mandatory The unique ID that represents a team. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/teams/{team_id}
Example Response
{ data: { id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", type: "teams", attributes: { modified_time_i18: "Apr12,9:42PM", member_type: 1, plan_type: 0, link_start_characters: "OCgNc", color: "#B5CC18", description: "", storage_info: { size: "5.18MB", storage_used: "5.18MB", files_count: 5, folders_count: 0, size_in_bytes: 5426572, storage_used_in_bytes: 5426572 }, is_discoverable: false, is_current_user_admin: true, created_time_i18: "Apr12,9:42PM", unread_count: 0, modified_time_in_millisecond: 1618243925136, modified_time: "Apr12,9:42PM", is_preferred: true, role_id: 32, member_status: 1, is_integrated_with_app: false, logo: {}, shared_status: "ACTIVE", created_time_in_millisecond: 1618243925136, superadmin_contact: "zylker@zylker.com", is_last_viewed: true, owner: "747937818", created_time: "Apr12,9:42PM", capabilities: { can_read: true, can_delete: true, can_edit: true, can_add_member: true, can_create_private_workspace: true, can_create_workspace: true, can_create_public_workspace: true, can_browse_workspace: true, can_manage_label: true, can_manage_task: true }, is_guest_user: false, watch_notification_count: 0, is_directory_enabled: false, invited_by: "ZylkerCreation", notification_count: 0, is_partof: true, created_by: "ZylkerCreation", license_status: 0, enable_myspace_storage_restriction: false, created_by_zuid: "747938014", product_type: 1, user_count: 1, license_obj: { purchased_for: 0, purchased_by: 0, policyinfo_id: 0, start_date: 0, billing_date: 0, allowed_space: 0, allowed_space_bytes: 0, bundle_id: 0, additional_storage: 0, remaining_license_users: 0, remaining_guest_users: 0, allowed_external_link_creation: 0, external_shared_to_users_limit: 0 }, parent_id: "-1", is_unread: false, name: "Zylker Creation", is_new_notification: false, is_current_user_super_admin: true }, relationships: { currentuser: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/currentuser", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/currentuser" } }, settings: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/settings", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/settings" } }, installapps: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/installapps", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/installapps" } }, records: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/records", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/records" } }, libraries: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/libraries", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/libraries" } }, groups: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/groups", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/groups" } }, users: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/users", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/users" } }, accesschartdata: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/accesschartdata", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/accesschartdata" } }, license: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/license", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/license" } }, install: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/install", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/install" } }, recordsuggestions: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/recordsuggestions", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/recordsuggestions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/timeline", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/timeline" } }, workspaces: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/workspaces", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/workspaces" } }, datatemplates: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/datatemplates", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/datatemplates" } }, apps: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/apps", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/apps" } } }, links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763" } } }
Show fullGet Team Members
This API fetches all members of a WorkDrive team.
Path Parameters
team_idstring | Mandatory The unique ID that represents a team. |
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
filter[user]string | Optional To get specific member's details, enter their ZUID.
|
search[all]string | Optional To search team members by custom search query.
|
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/teams/{team_id}/users
Example Response
{ data: [ { id: "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001", type: "users", attributes: { email_id: "zylker@zylker.com", member_type: 1, theme_color: "28B294", getting_started: 0, is_org_template_admin: true, ownership_transfer_id: "zylker@zylker.com", favoritedfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, default_view_type: 2, view_pref: { sort_by: "last_modified", sort_order: "desc", layout: "list" }, unread_count_myspace: 0, storage_info: { size: "231.0KB", storage_used: "231.0KB", files_count: 3, folders_count: 0, size_in_bytes: 237192, storage_used_in_bytes: 237192 }, mig_status: 0, last_login_time_in_millisecond: 0, files_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, invited_time: 1618243925174, user_type: 0, labeledfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, zid: "747938014", role_id: 32, is_sync_enabled: true, has_myfolder: true, last_accessed_library: "", is_mobile_enabled: true, last_accessed_folder: "", enable_myspace_restriction_all: false, connected_devices: 0, outgoingfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, capabilities: { can_create_group: true, can_access_myfolder: true, can_have_org_templates: true, can_sync: true, can_create_team: false }, incomingfiles_view_pref: { sort_by: "shared_time", sort_order: "desc", filtered_by: "all", layout: "list" }, app_names: [], display_name: "ZylkerCreation", shared_to: "747938014", zuid: "747938014", trashedfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, avatar_url: "https://contacts.zoho.com/file?t=user&ID=747938014&fs=thumb&nps=404", allowed_myspace_storage: -1, is_unread_myspace: false, invited_time_i18: "Apr12,9:42PM", zid_type: 262144, status: "ACTIVE" }, relationships: { privatespace: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/privatespace", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/privatespace" } }, teams: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/teams", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/teams" } }, devices: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/devices", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/devices" } }, records: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/records", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/records" } }, enterprise: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/enterprise", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/enterprise" } }, incomingfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/incomingfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/incomingfiles" } }, libraries: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/libraries", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/libraries" } }, favoritedfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/favoritedfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/favoritedfiles" } }, groups: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/groups", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/groups" } }, labels: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/labels", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/labels" } }, recentfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/recentfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/recentfiles" } }, license: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/license", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/license" } }, recordsuggestions: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/recordsuggestions", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/recordsuggestions" } }, organization: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/organization", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/organization" } }, collaborators: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/collaborators", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/collaborators" } }, labeledfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/labeledfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/labeledfiles" } }, incomingfolders: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/incomingfolders", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/incomingfolders" } }, workspaces: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/workspaces", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/workspaces" } }, unreadfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/unreadfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/unreadfiles" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/tasks", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/tasks" } }, notifications: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/notifications", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/notifications" } }, contacts: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/contacts", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/contacts" } }, apps: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/apps", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/apps" } } }, links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001" } } ] }
Show fullGet Current Team Member
This API fetches team member information about the user with respect to the team.
Path Parameters
team_idstring | Mandatory The unique ID that represents a team. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/teams/{team_id}/currentuser
Example Response
{ data: [ { id: "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001", type: "users", attributes: { email_id: "zylker@zylker.com", member_type: 1, theme_color: "28B294", getting_started: 0, is_org_template_admin: true, ownership_transfer_id: "zylker@zylker.com", favoritedfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, default_view_type: 2, view_pref: { sort_by: "last_modified", sort_order: "desc", layout: "list" }, unread_count_myspace: 0, storage_info: { size: "231.0KB", storage_used: "231.0KB", files_count: 3, folders_count: 0, size_in_bytes: 237192, storage_used_in_bytes: 237192 }, mig_status: 0, last_login_time_in_millisecond: 0, files_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, invited_time: 1618243925174, user_type: 0, labeledfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, zid: "747938014", role_id: 32, is_sync_enabled: true, has_myfolder: true, last_accessed_library: "", is_mobile_enabled: true, last_accessed_folder: "", enable_myspace_restriction_all: false, connected_devices: 0, outgoingfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, capabilities: { can_create_group: true, can_access_myfolder: true, can_have_org_templates: true, can_sync: true, can_create_team: false }, incomingfiles_view_pref: { sort_by: "shared_time", sort_order: "desc", filtered_by: "all", layout: "list" }, app_names: [], display_name: "ZylkerCreation", shared_to: "747938014", zuid: "747938014", trashedfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, avatar_url: "https://contacts.zoho.com/file?t=user&ID=747938014&fs=thumb&nps=404", allowed_myspace_storage: -1, is_unread_myspace: false, invited_time_i18: "Apr12,9:42PM", zid_type: 262144, status: "ACTIVE" }, relationships: { privatespace: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/privatespace", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/privatespace" } }, teams: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/teams", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/teams" } }, devices: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/devices", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/devices" } }, records: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/records", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/records" } }, enterprise: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/enterprise", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/enterprise" } }, incomingfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/incomingfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/incomingfiles" } }, libraries: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/libraries", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/libraries" } }, favoritedfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/favoritedfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/favoritedfiles" } }, groups: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/groups", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/groups" } }, labels: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/labels", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/labels" } }, recentfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/recentfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/recentfiles" } }, license: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/license", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/license" } }, recordsuggestions: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/recordsuggestions", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/recordsuggestions" } }, organization: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/organization", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/organization" } }, collaborators: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/collaborators", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/collaborators" } }, labeledfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/labeledfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/labeledfiles" } }, incomingfolders: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/incomingfolders", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/incomingfolders" } }, workspaces: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/workspaces", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/workspaces" } }, unreadfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/unreadfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/unreadfiles" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/tasks", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/tasks" } }, notifications: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/notifications", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/notifications" } }, contacts: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/contacts", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/contacts" } }, apps: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/relationships/apps", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001/apps" } } }, links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002001" } } ] }
Show fullChange Team Name
This API is used to change the team name in WorkDrive.
Path Parameters
team_idstring | Mandatory The unique ID that represents a team. |
Request Body Parameters
namestring | Mandatory The name of a team. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/teams/{team_id}
{ data: { attributes: { name: "Zylker Creation Limited" }, type: "teams" } }
Example Response
{ data: { id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", type: "teams", attributes: { modified_time_i18: "Apr12,10:06PM", member_type: 1, plan_type: 0, link_start_characters: "OCgNc", color: "#B5CC18", description: "", storage_info: { size: "5.18MB", storage_used: "5.18MB", files_count: 5, folders_count: 0, size_in_bytes: 5426572, storage_used_in_bytes: 5426572 }, is_discoverable: false, is_current_user_admin: true, created_time_i18: "Apr12,9:42PM", unread_count: 0, modified_time_in_millisecond: 1618245365827, modified_time: "Apr12,10:06PM", is_preferred: true, role_id: 32, member_status: 1, is_integrated_with_app: false, logo: {}, shared_status: "ACTIVE", created_time_in_millisecond: 1618243925136, superadmin_contact: "zylker@zylker.com", is_last_viewed: true, owner: "747937818", created_time: "Apr12,9:42PM", capabilities: { can_read: true, can_delete: true, can_edit: true, can_add_member: true, can_create_private_workspace: true, can_create_workspace: true, can_create_public_workspace: true, can_browse_workspace: true, can_manage_label: true, can_manage_task: true }, is_guest_user: false, watch_notification_count: 0, is_directory_enabled: false, invited_by: "Zylker Creation", notification_count: 0, is_partof: true, created_by: "Zylker Creation", license_status: 0, enable_myspace_storage_restriction: false, created_by_zuid: "747938014", product_type: 1, user_count: 1, license_obj: { purchased_for: 0, purchased_by: 0, policyinfo_id: 0, start_date: 0, billing_date: 0, allowed_space: 0, allowed_space_bytes: 0, bundle_id: 0, additional_storage: 0, remaining_license_users: 0, remaining_guest_users: 0, allowed_external_link_creation: 0, external_shared_to_users_limit: 0 }, parent_id: "-1", is_unread: false, name: "Zylker Creation Limited", is_new_notification: false, is_current_user_super_admin: true }, relationships: { currentuser: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/currentuser", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/currentuser" } }, settings: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/settings", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/settings" } }, installapps: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/installapps", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/installapps" } }, records: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/records", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/records" } }, libraries: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/libraries", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/libraries" } }, groups: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/groups", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/groups" } }, users: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/users", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/users" } }, accesschartdata: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/accesschartdata", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/accesschartdata" } }, license: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/license", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/license" } }, install: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/install", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/install" } }, recordsuggestions: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/recordsuggestions", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/recordsuggestions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/timeline", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/timeline" } }, workspaces: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/workspaces", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/workspaces" } }, datatemplates: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/datatemplates", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/datatemplates" } }, apps: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/apps", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/apps" } } }, links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763" } } }
Show fullChange Preferred Team
This API helps in changing the preferred team that the user wants to view on the left panel in the WorkDrive web application.
Path Parameters
team_idstring | Mandatory The unique ID that represents a team. |
Request Body Parameters
is_preferredboolean | Mandatory Mention "true" to set the current team as the preferred team. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/teams/{team_id}
{ data: { attributes: { is_preferred: "true" }, type: "teams" } }
Example Response
{ data: { id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", type: "teams", attributes: { modified_time_i18: "Apr12,10:06PM", member_type: 1, plan_type: 0, link_start_characters: "OCgNc", color: "#B5CC18", description: "", storage_info: { size: "5.18MB", storage_used: "5.18MB", files_count: 5, folders_count: 0, size_in_bytes: 5426572, storage_used_in_bytes: 5426572 }, is_discoverable: false, is_current_user_admin: true, created_time_i18: "Apr12,9:42PM", unread_count: 0, modified_time_in_millisecond: 1618245365827, modified_time: "Apr12,10:06PM", is_preferred: true, role_id: 32, member_status: 1, is_integrated_with_app: false, logo: {}, shared_status: "ACTIVE", created_time_in_millisecond: 1618243925136, superadmin_contact: "zylker@zylker.com", is_last_viewed: true, owner: "747937818", created_time: "Apr12,9:42PM", capabilities: { can_read: true, can_delete: true, can_edit: true, can_add_member: true, can_create_private_workspace: true, can_create_workspace: true, can_create_public_workspace: true, can_browse_workspace: true, can_manage_label: true, can_manage_task: true }, is_guest_user: false, watch_notification_count: 0, is_directory_enabled: false, invited_by: "Zylker Creation", notification_count: 0, is_partof: true, created_by: "ZylkerCreation", license_status: 0, enable_myspace_storage_restriction: false, created_by_zuid: "747938014", product_type: 1, user_count: 1, license_obj: { purchased_for: 0, purchased_by: 0, policyinfo_id: 0, start_date: 0, billing_date: 0, allowed_space: 0, allowed_space_bytes: 0, bundle_id: 0, additional_storage: 0, remaining_license_users: 0, remaining_guest_users: 0, allowed_external_link_creation: 0, external_shared_to_users_limit: 0 }, parent_id: "-1", is_unread: false, name: "Zylker Creation Limited", is_new_notification: false, is_current_user_super_admin: true }, relationships: { currentuser: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/currentuser", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/currentuser" } }, settings: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/settings", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/settings" } }, installapps: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/installapps", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/installapps" } }, records: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/records", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/records" } }, libraries: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/libraries", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/libraries" } }, groups: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/groups", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/groups" } }, users: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/users", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/users" } }, accesschartdata: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/accesschartdata", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/accesschartdata" } }, license: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/license", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/license" } }, install: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/install", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/install" } }, recordsuggestions: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/recordsuggestions", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/recordsuggestions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/timeline", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/timeline" } }, workspaces: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/workspaces", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/workspaces" } }, datatemplates: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/datatemplates", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/datatemplates" } }, apps: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/apps", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/apps" } } }, links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763" } } }
Show fullChange Team Description
This API changes your team description in WorkDrive.
Path Parameters
team_idstring | Mandatory The unique ID that represents a team. |
Request Body Parameters
descriptionstring | Mandatory A brief description about the team. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/teams/{team_id}
{ data: { attributes: { description: "To manage files of Zylker Creation" }, type: "teams" } }
Example Response
{ data: { id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", type: "teams", attributes: { modified_time_i18: "Apr12,10:06PM", member_type: 1, plan_type: 0, link_start_characters: "OCgNc", color: "#B5CC18", description: "To manage files of Zylker Creation", storage_info: { size: "5.18MB", storage_used: "5.18MB", files_count: 5, folders_count: 0, size_in_bytes: 5426572, storage_used_in_bytes: 5426572 }, is_discoverable: false, is_current_user_admin: true, created_time_i18: "Apr12,9:42PM", unread_count: 0, modified_time_in_millisecond: 1618245365827, modified_time: "Apr12,10:06PM", is_preferred: true, role_id: 32, member_status: 1, is_integrated_with_app: false, logo: {}, shared_status: "ACTIVE", created_time_in_millisecond: 1618243925136, superadmin_contact: "zylker@zylker.com", is_last_viewed: true, owner: "747937818", created_time: "Apr12,9:42PM", capabilities: { can_read: true, can_delete: true, can_edit: true, can_add_member: true, can_create_private_workspace: true, can_create_workspace: true, can_create_public_workspace: true, can_browse_workspace: true, can_manage_label: true, can_manage_task: true }, is_guest_user: false, watch_notification_count: 0, is_directory_enabled: false, invited_by: "Zylker Creation", notification_count: 0, is_partof: true, created_by: "ZylkerCreation", license_status: 0, enable_myspace_storage_restriction: false, created_by_zuid: "747938014", product_type: 1, user_count: 1, license_obj: { purchased_for: 0, purchased_by: 0, policyinfo_id: 0, start_date: 0, billing_date: 0, allowed_space: 0, allowed_space_bytes: 0, bundle_id: 0, additional_storage: 0, remaining_license_users: 0, remaining_guest_users: 0, allowed_external_link_creation: 0, external_shared_to_users_limit: 0 }, parent_id: "-1", is_unread: false, name: "Zylker Creation Limited", is_new_notification: false, is_current_user_super_admin: true }, relationships: { currentuser: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/currentuser", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/currentuser" } }, settings: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/settings", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/settings" } }, installapps: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/installapps", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/installapps" } }, records: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/records", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/records" } }, libraries: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/libraries", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/libraries" } }, groups: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/groups", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/groups" } }, users: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/users", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/users" } }, accesschartdata: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/accesschartdata", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/accesschartdata" } }, license: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/license", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/license" } }, install: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/install", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/install" } }, recordsuggestions: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/recordsuggestions", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/recordsuggestions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/timeline", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/timeline" } }, workspaces: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/workspaces", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/workspaces" } }, datatemplates: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/datatemplates", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/datatemplates" } }, apps: { links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/relationships/apps", related: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763/apps" } } }, links: { self: "https://www.zohoapis.com/workdrive/teams/ly9zmae16b43c258f458a9a57ac02c4f8d763" } } }
Show fullGet Team Folders in a Team
This API fetches the list of all team folders in a team.
Path Parameters
team_idstring | Mandatory The unique ID that represents a team. |
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 teamfolder type. Eg. filter[type]=userjoinedws For a list of filter types, see Team folder filter in the Filters page. Refer here |
page[limit]string | Optional Limit indicates the number of items to be listed. For More Details about pagination, refer here |
page[offset]string | Optional Offset indicates from where the listing should start. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/teams/{team_id}/teamfolders?page%5Blimit%5D=50&page%5Boffset%5D=0
Example Response
{ data: [ { id: "ly9zmacc69de0061b47ad9f09060734858fc4", type: "teamfolders", attributes: { is_app_owned: false, is_public_within_team: true, is_pinned: true, view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, groups_count: 0, created_time_in_milliseconds: 1618243925800, description: "", is_built_in: true, storage_info: { size: "4.95 MB", storage_used: "4.95 MB", files_count: 2, folders_count: 0, size_in_bytes: 5189380, storage_used_in_bytes: 5189380 }, last_accessed_time_in_milliseconds: 1618243925800, is_current_user_admin: true, files_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, unread_count: 0, role_id: 1, shared_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, is_app_associated: false, last_accessed_time: "Apr 12, 9:42 PM", is_share_allowed: true, created_time: "Apr 12, 9:42 PM", collaborators_count: 2, capabilities: { can_read: true, can_share: true, can_delete: true, can_edit: true, can_manage: true, can_create_files: true, can_upload_files: true, can_trash_files: true, can_leave: true, can_add_members: true, can_join: false, can_download_files: true }, unread_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, incomingfiles_view_pref: { sort_by: "shared_time", sort_order: "desc", filtered_by: "all", layout: "list" }, is_org_team_folder: false, display_attr_name: "General", is_partof: true, is_default: false, created_by: "Zylker Creation", display_html_name: "General", created_by_zuid: "747938014", display_url_name: "General", parent_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", last_accessed_by: "Zylker Creation", is_unread: false, name: "General", status: 1 }, relationships: { settings: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/relationships/settings", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/settings" } }, folders: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/relationships/folders", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/folders" } }, incomingfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/relationships/incomingfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/incomingfiles" } }, trashedfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/relationships/trashedfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/trashedfiles" } }, mydrafts: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/relationships/mydrafts", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/mydrafts" } }, deletedfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/relationships/deletedfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/deletedfiles" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/relationships/permissions", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/permissions" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/relationships/files", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/files" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/relationships/timeline", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/timeline" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/relationships/links", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/links" } }, incomingfolders: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/relationships/incomingfolders", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/incomingfolders" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/relationships/copy", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/copy" } }, unreadfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/relationships/unreadfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/unreadfiles" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/relationships/entity", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/entity" } }, outgoingfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/relationships/outgoingfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/outgoingfiles" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/relationships/appdata", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zmacc69de0061b47ad9f09060734858fc4" } }, { id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", type: "teamfolders", attributes: { is_app_owned: false, is_public_within_team: false, is_pinned: false, view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, groups_count: 0, created_time_in_milliseconds: 1618251055482, description: "", is_built_in: false, storage_info: { size: "0 bytes", storage_used: "0 bytes", files_count: 0, folders_count: 0, size_in_bytes: 0, storage_used_in_bytes: 0 }, last_accessed_time_in_milliseconds: 1618251055482, is_current_user_admin: true, files_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, unread_count: 0, role_id: 1, shared_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, is_app_associated: false, last_accessed_time: "Apr 12, 11:40 PM", is_share_allowed: true, created_time: "Apr 12, 11:40 PM", collaborators_count: 1, capabilities: { can_read: true, can_share: true, can_delete: true, can_edit: true, can_manage: true, can_create_files: true, can_upload_files: true, can_trash_files: true, can_leave: true, can_add_members: true, can_join: false, can_download_files: true }, unread_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, incomingfiles_view_pref: { sort_by: "shared_time", sort_order: "desc", filtered_by: "all", layout: "list" }, is_org_team_folder: false, display_attr_name: "Marketing Details", is_partof: true, is_default: false, created_by: "Zylker Creation", display_html_name: "Marketing Details", created_by_zuid: "747938014", display_url_name: "Marketing+Details", parent_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", last_accessed_by: "Zylker Creation", is_unread: false, name: "Marketing Details", status: 1 }, relationships: { settings: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/settings", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/settings" } }, folders: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/folders", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/folders" } }, incomingfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/incomingfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/incomingfiles" } }, trashedfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/trashedfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/trashedfiles" } }, mydrafts: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/mydrafts", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/mydrafts" } }, deletedfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/deletedfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/deletedfiles" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/permissions", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/permissions" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/files", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/files" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/timeline", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/timeline" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/links", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/links" } }, incomingfolders: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/incomingfolders", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/incomingfolders" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/copy", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/copy" } }, unreadfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/unreadfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/unreadfiles" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/entity", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/entity" } }, outgoingfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/outgoingfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/outgoingfiles" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/appdata", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68" } } ] }
Show fullGet List of Data Templates in a Team
This API fetches a list of all the data templates associated with a WorkDrive team.
Path Parameters
team_idstring | Mandatory The unique ID that represents a team. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/teams/{team_id}/datatemplates
Example Response
{ data: [ { id: "nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001", type: "datatemplates", attributes: { created_time_i18: "Sep 7, 6:40 PM", name: "Recruitment - 2021", modified_by: "15077877", description: "Associate files and folders of all candidates registered for recruitment in 2021", modified_by_user: "Anna Baker", team_id: "nrkroc4c5f3259e2a410da17c3915ea990dde", custom_fields_count: 2, created_time_in_millisecond: 1631020235366, created_by: "15077877", created_by_user: "Anna Baker", status: true }, relationships: { customfields: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/datatemplates/nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001/relationships/customfields", related: "https://www.zohoapis.com/workdrive/api/v1/datatemplates/nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001/customfields" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/datatemplates/nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001" } } ] }
Show fullTeam Folder
Team folder is a shared folder in WorkDrive. It is of two types: Private and Public.
Get Team Folder Info
This API fetches all the information about a team folder.
Path Parameters
teamfolder_idstring | Mandatory The unique ID of a team folder. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/teamfolders/{teamfolder_id}
Example Response
{ data: { id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", type: "teamfolders", attributes: { is_app_owned: false, is_public_within_team: false, is_pinned: false, view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, groups_count: 0, created_time_in_milliseconds: 1618251055482, description: "", is_built_in: false, storage_info: { size: "92.0 KB", storage_used: "92.0 KB", files_count: 1, folders_count: 0, size_in_bytes: 94427, storage_used_in_bytes: 94427 }, last_accessed_time_in_milliseconds: 1618251055482, is_current_user_admin: true, files_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, unread_count: 0, role_id: 1, shared_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, is_app_associated: false, last_accessed_time: "Apr 12, 11:40 PM", is_share_allowed: true, created_time: "Apr 12, 11:40 PM", collaborators_count: 1, capabilities: { can_read: true, can_share: true, can_delete: true, can_edit: true, can_manage: true, can_create_files: true, can_upload_files: true, can_trash_files: true, can_leave: true, can_add_members: true, can_join: false, can_download_files: true }, unread_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, incomingfiles_view_pref: { sort_by: "shared_time", sort_order: "desc", filtered_by: "all", layout: "list" }, is_org_team_folder: false, display_attr_name: "Marketing Details", is_partof: true, is_default: false, created_by: "Zylker Creation", display_html_name: "Marketing Details", created_by_zuid: "747938014", display_url_name: "Marketing+Details", parent_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", last_accessed_by: "Zylker Creation", is_unread: false, name: "Marketing Details", status: 1 }, relationships: { settings: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/settings", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/settings" } }, folders: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/folders", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/folders" } }, incomingfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/incomingfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/incomingfiles" } }, trashedfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/trashedfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/trashedfiles" } }, mydrafts: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/mydrafts", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/mydrafts" } }, deletedfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/deletedfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/deletedfiles" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/permissions", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/permissions" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/files", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/files" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/timeline", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/timeline" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/links", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/links" } }, incomingfolders: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/incomingfolders", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/incomingfolders" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/copy", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/copy" } }, unreadfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/unreadfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/unreadfiles" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/entity", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/entity" } }, outgoingfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/outgoingfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/outgoingfiles" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/appdata", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68" } } }
Show fullGet Team Folder Members
This API fetches all members who are part of a team folder.
Path Parameters
teamfolder_idstring |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/teamfolders/{teamfolder_id}/members
Example Response
{ data: [ { id: "ly9zm0170fb40015f4e2297a144e2b68cfa68-747938014", type: "members", attributes: { email_id: "zylker@zylker.com", shared_time_in_millis: 1618251055505, shared_by: "Zylker Creation", expiry_in_millis: 0, relation_type: 0, expiration_date: "", share_to_entity_info: { display_name: "Zylker Creation", email_id: "zylker@zylker.com", avatar_url: "https://contacts.zoho.com/file?t=user&ID=747938014&fs=thumb&nps=404" }, share_to_member_type: -1, role_id: 1, shared_time_i18: "Apr 12, 11:40 PM", shared_time: "Apr 12, 11:40 PM", shared_status: "ACTIVE", can_link_to_docs: true, owner: "747937818", allow_sharing_outside: false, shared_type: "workspace", delete_from_propagated_space: false, display_name: "Zylker Creation", message: "", share_to: "747938014", is_expired: false, shared_to_member_type: -1, avatar_url: "https://contacts.zoho.com/file?t=user&ID=747938014&fs=thumb&nps=404", is_password_protected: false, resource_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", permalink: "https://www.zohoapis.com/workdrive/file/ly9zm0170fb40015f4e2297a144e2b68cfa68", shared_by_zuid: "747938014" }, links: { self: "https://www.zohoapis.com/workdrive/members/ly9zm0170fb40015f4e2297a144e2b68cfa68-747938014" } } ] }
Show fullGet Team Folder Files and Folders
This API fetches all the files and folders in a team folder.
Path Parameters
teamfolder_idstring | Mandatory The unique ID of a team 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]=documents For list of filter type, see File filter in Filters page. Refer here |
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. 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. |
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. |
fields[files]string | Optional Mention the required params to be included in the response attribute. |
sortstring | Optional Sorting can be done with these fields:
|
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/teamfolders/{teamfolder_id}/files?page%5Blimit%5D=50&page%5Boffset%5D=0
Example Response
{ data: [ { id: "ly9zm4ab06bc0994343c6a24f7b11e3111037", type: "files", attributes: { modified_by_zuid: "747938058", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, destination_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", storage_info: { size: "90.0 KB", storage_used: "90.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 92684, storage_used_in_bytes: 92684 }, type: "image", created_time_i18: "Apr 13, 12:00 AM", modified_time_in_millisecond: 1618252229301, opened_time: "Apr 13, 12:00 AM", status_change_time: "Apr 13, 12:00 AM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/ly9zm4ab06bc0994343c6a24f7b11e3111037", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 13, 12:00 AM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "Capture.JPG", created_by: "Zylker Creation", display_html_name: "Capture.JPG", labels: [], parent_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", name: "Capture.JPG", status_change_time_in_millisecond: 1618252229301, permalink: "https://www.zohoapis.com/workdrive/file/ly9zm4ab06bc0994343c6a24f7b11e3111037", favorite: false, new_badge_count: 1, status: 1, modified_time_i18: "Apr 13, 12:00 AM", opened_time_i18: "Apr 13, 12:00 AM", extn: "jpg", shortcut_link: "", status_change_time_i18: "Apr 13, 12:00 AM", description: "", uploaded_time_in_millisecond: 1618252229303, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm4ab06bc0994343c6a24f7b11e3111037", title: "", modified_time: "Apr 13, 12:00 AM", library_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", icon_class: "img", created_time_in_millisecond: 1618252229301, owner: "747937818", creator: "747938058", capabilities: { can_read: true, can_share: true, can_remove_share: false, can_delete: false, can_edit: 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: true, can_share_support: true, can_label: true, can_checkout: true, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: true, can_trash_files: true }, uploaded_time_i18: "Apr 13, 12:00 AM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618252229301, edit_badge_count: 0, share_data: [], uploaded_time: "Apr 13, 12:00 AM", has_folders: false, service_type: "upload", display_url_name: "Capture.JPG", is_unread: true, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037" } } ], links: { cursor: { has_next: true, next: "https://www.zohoapis.com/workdrive/api/v1/files/vliy1b942de68431c4b92994025adf85d53fa/files?page[next]=dd1c097d208ec12c5093e359d5859fcce97ddbab18389052caa7d6ed2d6d37b073a8e94e651cfaf15c9c28d46b91b173663e37138b530a40854f2e27a31c" } } }
Show fullGet list of Sub Folders
This API fetches the list of sub folders in a team folder.
Path Parameters
teamfolder_idstring | Mandatory The unique ID of a team folder. |
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
page[limit]string | Optional Limit indicates the number of items to be listed. 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
|
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/teamfolders/{teamfolder_id}/folders?page%5Blimit%5D=50&page%5Boffset%5D=0
Example Response
{ data: [ { id: "ly9zm3bd32ac7cfdd45448e435bd20a6be500", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 0, is_fillable_resource: false, is_published: false, destination_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", 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, 12:02 AM", modified_time_in_millisecond: 1618252322314, opened_time: "Apr 13, 12:02 AM", status_change_time: "Apr 13, 12:02 AM", download_url: "https://www.zohoapis.com/workdrive/download/ly9zm3bd32ac7cfdd45448e435bd20a6be500", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 13, 12:02 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: "ly9zm0170fb40015f4e2297a144e2b68cfa68", name: "April", status_change_time_in_millisecond: 1618252322314, permalink: "https://www.zohoapis.com/workdrive/folder/ly9zm3bd32ac7cfdd45448e435bd20a6be500", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Apr 13, 12:02 AM", opened_time_i18: "Apr 13, 12:02 AM", extn: "", view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, shortcut_link: "", status_change_time_i18: "Apr 13, 12:02 AM", description: "", uploaded_time_in_millisecond: 1618252322317, thumbnail_url: "", title: "", files_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, modified_time: "Apr 13, 12:02 AM", library_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", icon_class: "folder", created_time_in_millisecond: 1618252322314, 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, 12:02 AM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618252322314, edit_badge_count: 0, share_data: [], uploaded_time: "Apr 13, 12:02 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/ly9zm3bd32ac7cfdd45448e435bd20a6be500/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3bd32ac7cfdd45448e435bd20a6be500" } } ] }
Show fullGet Team Folder Links
This API fetches all share links (i.e., external share links, download links, and embed codes) created in a team folder.
Path Parameters
teamfolder_idstring | Mandatory The unique ID of a team 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 link type. Eg. filter[type]=download For list of filter type, see Link filter in Filters page, refer here |
page[limit]string | Optional Limit indicates the number of items to be listed. For More Details about pagination, refer here |
page[offset]string | Optional Offset indicates from where the listing should start. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/teamfolders/{teamfolder_id}/links?page%5Blimit%5D=50&page%5Boffset%5D=0
Example Response
{ data: [ { id: "3iWUoMURXJU-OCgNc", type: "links", attributes: { modified_time_i18: "Apr 12, 11:54 PM", link: "https://workdrive.zohoexternal.com/external/3iWUoMURXJU-OCgNc", resource_extension: "png", input_fields: [], type: "image", created_time_i18: "Apr 12, 11:54 PM", request_user_data: false, modified_time: "Apr 12, 11:54 PM", role_id: 34, download_url: "https://workdrive.zohoexternal.com/external/3iWUoMURXJU-OCgNc/download", link_name: "public", modified_time_in_millis: 1618251899385, resource_status: 1, created_time: "Apr 12, 11:54 PM", file_name: "Screenshot from 2021-04-09 11-30-24.png", can_display_profile: false, created_by: "Zylker Creation", use_shorten_link: false, allow_download: true, link_type: "custom", is_expired: false, is_password_protected: false, modified_by: "Zylker Creation", resource_id: "ly9zm390af86b5a90443494b9136d914309f4", created_time_in_millis: 1618251899385, status: 1 }, relationships: { password: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXJU-OCgNc/relationships/password", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXJU-OCgNc/password" } }, report: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXJU-OCgNc/relationships/report", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXJU-OCgNc/report" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXJU-OCgNc/relationships/timeline", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXJU-OCgNc/timeline" } }, register: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXJU-OCgNc/relationships/register", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXJU-OCgNc/register" } } }, links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXJU-OCgNc" } } ] }
Show fullGet Team Folder Settings
This API fetches the settings of a team folder.
Path Parameters
teamfolder_idstring | Mandatory The unique ID of a team folder. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/teamfolders/{teamfolder_id}/settings
Example Response
{ data: { id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", type: "settings", attributes: { allow_external_sharing: true, data_template_setting: {}, create_file_as_draft: true, allow_ws_to_change_conversion: true, allow_my_folder_to_change_conversion: false, allow_create_ws: 0, email_in: { is_enabled: false, receive_external_mail: false }, is_external_share_enabled: true, enable_org_logo: false, is_document_conversion: false, can_viewer_download: true, setting_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68" }, links: { self: "https://www.zohoapis.com/workdrive/settings/ly9zm0170fb40015f4e2297a144e2b68cfa68" } } }
Show fullGet Team Folder MyDraft Files
This API fetches the list of all of the draft files in a team folder.
Note:
The drafted files will be visible only to the File Owners and not visible to the other team members.
Path Parameters
teamfolder_idstring | Mandatory The unique ID of a team 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]=documents For list of filter type, see File filter in Filters page, refer here |
page[limit]string | Optional Limit indicates the number of items to be listed. 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:
|
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/teamfolders/{teamfolder_id}/mydrafts?page%5Blimit%5D=50&page%5Boffset%5D=0
Example Response
{ data: [ { id: "ly9zm6bfb474b23d945288fd11f123c05843e", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 0, is_fillable_resource: false, is_published: false, collab_id: "2243193149594280833", destination_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", 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: "writer", created_time_i18: "Apr 13, 12:07 AM", modified_time_in_millisecond: 1618252689155, opened_time: "Apr 13, 12:07 AM", status_change_time: "Apr 13, 12:08 AM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/ly9zm6bfb474b23d945288fd11f123c05843e", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 13, 12:07 AM", lock_status: 2, is_folder: false, resource_type: 2001, is_email_in_upload: false, display_attr_name: "Report April Month", created_by: "Zylker Creation", display_html_name: "Report April Month", labels: [], parent_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", name: "Report April Month", status_change_time_in_millisecond: 1618252689155, permalink: "https://writer.zoho.com/writer/open/ly9zm6bfb474b23d945288fd11f123c05843e", favorite: false, new_badge_count: 0, status: 4, modified_time_i18: "Apr 13, 12:08 AM", opened_time_i18: "Apr 13, 12:07 AM", extn: "zwriter", shortcut_link: "", status_change_time_i18: "Apr 13, 12:08 AM", description: "", uploaded_time_in_millisecond: 1618252658914, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm6bfb474b23d945288fd11f123c05843e", title: "", modified_time: "Apr 13, 12:08 AM", library_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", icon_class: "writer", created_time_in_millisecond: 1618252658911, owner: "747937818", creator: "747938014", capabilities: { can_read: true, can_share: true, can_remove_share: false, can_delete: true, can_edit: true, can_upload_files: false, can_trash: false, can_rename: true, can_restore: false, can_copy: false, can_move: false, can_zip: true, can_download: true, can_emailattach: true, can_publish: true, can_create_task: true, can_share_support: true, can_label: true, can_checkout: false, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: true, can_trash_files: false }, uploaded_time_i18: "Apr 13, 12:07 AM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618252658911, edit_badge_count: 0, share_data: [], uploaded_time: "Apr 13, 12:07 AM", has_folders: false, service_type: "zw", display_url_name: "Report+April+Month", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e" } } ] }
Show fullGet Team Folder Unread Files
This API fetches all the unread files in a team folder.
Path Parameters
teamfolder_idstring | Mandatory The unique ID of a team 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]=documents For list of filter type, see File filter in Filters page, refer here |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/teamfolders/{teamfolder_id}/unreadfiles
Example Response
{ data: [ { id: "ly9zm4ab06bc0994343c6a24f7b11e3111037", type: "files", attributes: { modified_by_zuid: "747938058", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, destination_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", storage_info: { size: "90.0 KB", storage_used: "90.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 92684, storage_used_in_bytes: 92684 }, type: "image", created_time_i18: "Apr 13, 12:00 AM", modified_time_in_millisecond: 1618252229301, opened_time: "Apr 13, 12:00 AM", status_change_time: "Apr 13, 12:00 AM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/ly9zm4ab06bc0994343c6a24f7b11e3111037", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 13, 12:00 AM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "Capture.JPG", created_by: "Zylker Creation", display_html_name: "Capture.JPG", labels: [], parent_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", name: "Capture.JPG", status_change_time_in_millisecond: 1618252229301, permalink: "https://www.zohoapis.com/workdrive/file/ly9zm4ab06bc0994343c6a24f7b11e3111037", favorite: false, new_badge_count: 1, status: 1, modified_time_i18: "Apr 13, 12:00 AM", opened_time_i18: "Apr 13, 12:00 AM", extn: "jpg", shortcut_link: "", status_change_time_i18: "Apr 13, 12:00 AM", description: "", uploaded_time_in_millisecond: 1618252229303, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm4ab06bc0994343c6a24f7b11e3111037", title: "", modified_time: "Apr 13, 12:00 AM", library_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", icon_class: "img", created_time_in_millisecond: 1618252229301, owner: "747937818", creator: "747938058", uploaded_time_i18: "Apr 13, 12:00 AM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618252229301, edit_badge_count: 0, share_data: [], uploaded_time: "Apr 13, 12:00 AM", has_folders: false, service_type: "upload", display_url_name: "Capture.JPG", is_unread: true, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037" } } ] }
Show fullGet Team Folder Trashed Files
This API fetches all the files in a team folder's Trash.
Path Parameters
teamfolder_idstring | Mandatory The unique ID of a team 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]=documents For list of filter type, see File filter in Filters page, refer here |
page[limit]string | Optional Limit indicates the number of items to be listed. 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:
|
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/teamfolders/{teamfolder_id}/trashedfiles?page%5Blimit%5D=50&page%5Boffset%5D=0
Example Response
{ data: [ { id: "ly9zm390af86b5a90443494b9136d914309f4", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, destination_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", storage_info: { size: "92.0 KB", storage_used: "92.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 94427, storage_used_in_bytes: 94427 }, type: "image", created_time_i18: "Apr 12, 11:54 PM", modified_time_in_millisecond: 1618252288420, opened_time: "Apr 12, 11:54 PM", status_change_time: "Apr 13, 12:01 AM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/ly9zm390af86b5a90443494b9136d914309f4", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 12, 11:54 PM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "Screenshot from 2021-04-09 11-30-24.png", created_by: "Zylker Creation", display_html_name: "Screenshot from 2021-04-09 11-30-24.png", labels: [], parent_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", name: "Screenshot from 2021-04-09 11-30-24.png", status_change_time_in_millisecond: 1618252288420, permalink: "https://www.zohoapis.com/workdrive/file/ly9zm390af86b5a90443494b9136d914309f4", favorite: false, new_badge_count: 0, status: 51, modified_time_i18: "Apr 13, 12:01 AM", opened_time_i18: "Apr 12, 11:54 PM", extn: "png", shortcut_link: "", status_change_time_i18: "Apr 13, 12:01 AM", description: "", uploaded_time_in_millisecond: 1618251883433, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm390af86b5a90443494b9136d914309f4", title: "", modified_time: "Apr 13, 12:01 AM", library_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", icon_class: "img", created_time_in_millisecond: 1618251883431, owner: "747937818", creator: "747938014", capabilities: { can_read: false, can_share: false, can_remove_share: false, can_delete: true, can_edit: false, can_upload_files: false, can_trash: false, can_rename: false, can_restore: true, can_copy: false, can_move: false, can_zip: false, can_download: false, can_emailattach: false, can_publish: false, can_create_task: false, can_share_support: false, can_label: true, can_checkout: false, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: false, can_create_comment: false, can_trash_files: false }, uploaded_time_i18: "Apr 12, 11:54 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618251883431, edit_badge_count: 0, share_data: [], uploaded_time: "Apr 12, 11:54 PM", has_folders: false, service_type: "upload", display_url_name: "Screenshot+from+2021-04-09+11-30-24.png", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm390af86b5a90443494b9136d914309f4" } } ] }
Show fullCreate Team Folder
This API creates a new team folder in a team.
Request Body Parameters
namestring | Mandatory A name for the new team folder. |
parent_idstring | Mandatory The unique ID of a team. |
is_public_within_teamboolean | Mandatory Mention "true" to make the team folder type 'Public'. |
descriptionstring | Optional Brief description about the team folder. |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/teamfolders
{ data: { attributes: { name: "Marketing Details", parent_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", is_public_within_team: "false", description: "Marketing related files" }, type: "teamfolders" } }
Example Response
{ data: { id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", type: "teamfolders", attributes: { is_app_owned: false, is_public_within_team: false, is_pinned: false, view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, groups_count: 0, created_time_in_milliseconds: 1618251055482, description: "Marketing related files", is_built_in: false, storage_info: { size: "0 bytes", storage_used: "0 bytes", files_count: 0, folders_count: 0, size_in_bytes: 0, storage_used_in_bytes: 0 }, last_accessed_time_in_milliseconds: 1618251055482, is_current_user_admin: true, files_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, unread_count: 0, role_id: 1, shared_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, is_app_associated: false, last_accessed_time: "Apr 12, 11:40 PM", is_share_allowed: true, created_time: "Apr 12, 11:40 PM", collaborators_count: 1, capabilities: { can_read: true, can_share: true, can_delete: true, can_edit: true, can_manage: true, can_create_files: true, can_upload_files: true, can_trash_files: true, can_leave: true, can_add_members: true, can_join: false, can_download_files: true }, unread_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, incomingfiles_view_pref: { sort_by: "shared_time", sort_order: "desc", filtered_by: "all", layout: "list" }, is_org_team_folder: false, display_attr_name: "Marketing Details", is_partof: true, is_default: false, created_by: "Zylker Creation", display_html_name: "Marketing Details", created_by_zuid: "747938014", display_url_name: "Marketing+Details", parent_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", last_accessed_by: "Zylker Creation", is_unread: false, name: "Marketing Details", status: 1 }, relationships: { settings: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/settings", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/settings" } }, folders: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/folders", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/folders" } }, incomingfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/incomingfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/incomingfiles" } }, trashedfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/trashedfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/trashedfiles" } }, mydrafts: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/mydrafts", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/mydrafts" } }, deletedfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/deletedfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/deletedfiles" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/permissions", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/permissions" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/files", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/files" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/timeline", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/timeline" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/links", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/links" } }, incomingfolders: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/incomingfolders", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/incomingfolders" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/copy", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/copy" } }, unreadfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/unreadfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/unreadfiles" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/entity", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/entity" } }, outgoingfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/outgoingfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/outgoingfiles" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/appdata", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68" } } }
Show fullPin Team Folder
With the Pin feature, you can quickly access important Team Folders from a long list. When a Team Folder is pinned, it will appear at the top of the Team Folder list.
Note:
If there are multiple pinned Team Folders, it will get sorted in alphabetical order.
This API pins a Team Folder at the top of the Team Folder list.
Path Parameters
teamfolder_idstring | Mandatory The unique ID of a team folder. |
Request Body Parameters
is_pinnedboolean | Mandatory Set as "true" to pin the team folder |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/teamfolders/{teamfolder_id}
{ data: { attributes: { is_pinned: "true" }, type: "teamfolders" } }
Example Response
{ data: { id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", type: "teamfolders", attributes: { is_app_owned: false, is_public_within_team: false, is_pinned: true, view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, groups_count: 0, created_time_in_milliseconds: 1618251055482, description: "Marketing related files", is_built_in: false, storage_info: { size: "90.0 KB", storage_used: "90.0 KB", files_count: 2, folders_count: 1, size_in_bytes: 92684, storage_used_in_bytes: 92684 }, last_accessed_time_in_milliseconds: 1618253011931, is_current_user_admin: true, files_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, unread_count: 1, role_id: 1, shared_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, is_app_associated: false, last_accessed_time: "Apr 13, 12:13 AM", is_share_allowed: true, created_time: "Apr 12, 11:40 PM", collaborators_count: 2, capabilities: { can_read: true, can_share: true, can_delete: true, can_edit: true, can_manage: true, can_create_files: true, can_upload_files: true, can_trash_files: true, can_leave: true, can_add_members: true, can_join: false, can_download_files: true }, unread_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, incomingfiles_view_pref: { sort_by: "shared_time", sort_order: "desc", filtered_by: "all", layout: "list" }, is_org_team_folder: false, display_attr_name: "Marketing Details 2021", is_partof: true, is_default: false, created_by: "Zylker Creation", display_html_name: "Marketing Details 2021", created_by_zuid: "747938014", display_url_name: "Marketing+Details+2021", parent_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", last_accessed_by: "Zylker Creation", is_unread: true, name: "Marketing Details 2021", status: 1 }, relationships: { settings: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/settings", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/settings" } }, folders: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/folders", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/folders" } }, incomingfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/incomingfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/incomingfiles" } }, trashedfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/trashedfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/trashedfiles" } }, mydrafts: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/mydrafts", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/mydrafts" } }, deletedfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/deletedfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/deletedfiles" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/permissions", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/permissions" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/files", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/files" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/timeline", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/timeline" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/links", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/links" } }, incomingfolders: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/incomingfolders", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/incomingfolders" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/copy", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/copy" } }, unreadfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/unreadfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/unreadfiles" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/entity", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/entity" } }, outgoingfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/outgoingfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/outgoingfiles" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/appdata", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68" } } }
Show fullUnpin Team Folder
This API unpins a Team Folder from the Team Folder list.
Path Parameters
teamfolder_idstring | Mandatory The unique ID of a team folder. |
Request Body Parameters
is_pinnedboolean | Mandatory Set as "false" to unpin the team folder |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/teamfolders/{teamfolder_id}
{ data: { attributes: { is_pinned: "false" }, type: "teamfolders" } }
Example Response
{ data: { id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", type: "teamfolders", attributes: { is_app_owned: false, is_public_within_team: false, is_pinned: false, view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, groups_count: 0, created_time_in_milliseconds: 1618251055482, description: "Marketing related files", is_built_in: false, storage_info: { size: "90.0 KB", storage_used: "90.0 KB", files_count: 2, folders_count: 1, size_in_bytes: 92684, storage_used_in_bytes: 92684 }, last_accessed_time_in_milliseconds: 1618253011931, is_current_user_admin: true, files_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, unread_count: 1, role_id: 1, shared_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, is_app_associated: false, last_accessed_time: "Apr 13, 12:13 AM", is_share_allowed: true, created_time: "Apr 12, 11:40 PM", collaborators_count: 2, capabilities: { can_read: true, can_share: true, can_delete: true, can_edit: true, can_manage: true, can_create_files: true, can_upload_files: true, can_trash_files: true, can_leave: true, can_add_members: true, can_join: false, can_download_files: true }, unread_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, incomingfiles_view_pref: { sort_by: "shared_time", sort_order: "desc", filtered_by: "all", layout: "list" }, is_org_team_folder: false, display_attr_name: "Marketing Details 2021", is_partof: true, is_default: false, created_by: "Zylker Creation", display_html_name: "Marketing Details 2021", created_by_zuid: "747938014", display_url_name: "Marketing+Details+2021", parent_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", last_accessed_by: "Zylker Creation", is_unread: true, name: "Marketing Details 2021", status: 1 }, relationships: { settings: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/settings", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/settings" } }, folders: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/folders", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/folders" } }, incomingfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/incomingfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/incomingfiles" } }, trashedfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/trashedfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/trashedfiles" } }, mydrafts: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/mydrafts", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/mydrafts" } }, deletedfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/deletedfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/deletedfiles" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/permissions", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/permissions" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/files", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/files" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/timeline", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/timeline" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/links", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/links" } }, incomingfolders: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/incomingfolders", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/incomingfolders" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/copy", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/copy" } }, unreadfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/unreadfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/unreadfiles" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/entity", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/entity" } }, outgoingfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/outgoingfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/outgoingfiles" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/appdata", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68" } } }
Show fullChange Team Folder Description
This API changes a team folder's description.
Path Parameters
teamfolder_idstring | Mandatory The unique ID of a team folder. |
Request Body Parameters
descriptionstring | Mandatory A brief description about the team folder. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/teamfolders/{teamfolder_id}
{ data: { attributes: { description: "To store marketing reports" }, type: "teamfolders" } }
Example Response
{ data: { id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", type: "teamfolders", attributes: { is_app_owned: false, is_public_within_team: false, is_pinned: true, view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, groups_count: 0, created_time_in_milliseconds: 1618251055482, description: "To store marketing reports", is_built_in: false, storage_info: { size: "90.0 KB", storage_used: "90.0 KB", files_count: 2, folders_count: 1, size_in_bytes: 92684, storage_used_in_bytes: 92684 }, last_accessed_time_in_milliseconds: 1618253011931, is_current_user_admin: true, files_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, unread_count: 1, role_id: 1, shared_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, is_app_associated: false, last_accessed_time: "Apr 13, 12:13 AM", is_share_allowed: true, created_time: "Apr 12, 11:40 PM", collaborators_count: 2, capabilities: { can_read: true, can_share: true, can_delete: true, can_edit: true, can_manage: true, can_create_files: true, can_upload_files: true, can_trash_files: true, can_leave: true, can_add_members: true, can_join: false, can_download_files: true }, unread_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, incomingfiles_view_pref: { sort_by: "shared_time", sort_order: "desc", filtered_by: "all", layout: "list" }, is_org_team_folder: false, display_attr_name: "Marketing Details 2021", is_partof: true, is_default: false, created_by: "Zylker Creation", display_html_name: "Marketing Details 2021", created_by_zuid: "747938014", display_url_name: "Marketing+Details+2021", parent_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", last_accessed_by: "Zylker Creation", is_unread: true, name: "Marketing Details 2021", status: 1 }, relationships: { settings: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/settings", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/settings" } }, folders: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/folders", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/folders" } }, incomingfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/incomingfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/incomingfiles" } }, trashedfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/trashedfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/trashedfiles" } }, mydrafts: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/mydrafts", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/mydrafts" } }, deletedfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/deletedfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/deletedfiles" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/permissions", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/permissions" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/files", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/files" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/timeline", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/timeline" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/links", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/links" } }, incomingfolders: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/incomingfolders", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/incomingfolders" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/copy", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/copy" } }, unreadfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/unreadfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/unreadfiles" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/entity", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/entity" } }, outgoingfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/outgoingfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/outgoingfiles" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/appdata", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68" } } }
Show fullChange Team Folder Name
This API changes a team folder's name.
Path Parameters
teamfolder_idstring | Mandatory The unique ID of a team folder. |
Request Body Parameters
namestring | Mandatory The name of the team folder. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/teamfolders/{teamfolder_id}
{ data: { attributes: { name: "Marketing Details 2021" }, type: "teamfolders" } }
Example Response
{ data: { id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", type: "teamfolders", attributes: { is_app_owned: false, is_public_within_team: false, is_pinned: true, view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, groups_count: 0, created_time_in_milliseconds: 1618251055482, description: "Marketing related files", is_built_in: false, storage_info: { size: "90.0 KB", storage_used: "90.0 KB", files_count: 2, folders_count: 1, size_in_bytes: 92684, storage_used_in_bytes: 92684 }, last_accessed_time_in_milliseconds: 1618253011931, is_current_user_admin: true, files_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, unread_count: 1, role_id: 1, shared_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, is_app_associated: false, last_accessed_time: "Apr 13, 12:13 AM", is_share_allowed: true, created_time: "Apr 12, 11:40 PM", collaborators_count: 2, capabilities: { can_read: true, can_share: true, can_delete: true, can_edit: true, can_manage: true, can_create_files: true, can_upload_files: true, can_trash_files: true, can_leave: true, can_add_members: true, can_join: false, can_download_files: true }, unread_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, incomingfiles_view_pref: { sort_by: "shared_time", sort_order: "desc", filtered_by: "all", layout: "list" }, is_org_team_folder: false, display_attr_name: "Marketing Details 2021", is_partof: true, is_default: false, created_by: "Zylker Creation", display_html_name: "Marketing Details 2021", created_by_zuid: "747938014", display_url_name: "Marketing+Details+2021", parent_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", last_accessed_by: "Zylker Creation", is_unread: true, name: "Marketing Details 2021", status: 1 }, relationships: { settings: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/settings", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/settings" } }, folders: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/folders", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/folders" } }, incomingfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/incomingfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/incomingfiles" } }, trashedfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/trashedfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/trashedfiles" } }, mydrafts: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/mydrafts", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/mydrafts" } }, deletedfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/deletedfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/deletedfiles" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/permissions", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/permissions" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/files", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/files" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/timeline", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/timeline" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/links", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/links" } }, incomingfolders: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/incomingfolders", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/incomingfolders" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/copy", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/copy" } }, unreadfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/unreadfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/unreadfiles" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/entity", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/entity" } }, outgoingfiles: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/outgoingfiles", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/outgoingfiles" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/appdata", related: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68" } } }
Show fullEnable External Sharing
This API helps to enable or disable the external share settings in a team folder.
Path Parameters
teamfolder_idstring |
Request Body Parameters
allow_external_sharingboolean |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/settings/{teamfolder_id}
{ data: { attributes: { allow_external_sharing: "true" }, type: "settings" } }
Example Response
{ data: { id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", type: "settings", attributes: { allow_external_sharing: true, data_template_setting: {}, create_file_as_draft: true, allow_ws_to_change_conversion: true, allow_my_folder_to_change_conversion: false, allow_create_ws: 0, email_in: { is_enabled: false, receive_external_mail: false }, is_external_share_enabled: true, enable_org_logo: false, is_document_conversion: false, can_viewer_download: true, setting_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68" }, links: { self: "https://www.zohoapis.com/workdrive/settings/ly9zm0170fb40015f4e2297a144e2b68cfa68" } } }
Show fullEmpty Team Folder Trash
This API clears the files and folders in the team folder trash permanently.
Request Body Parameters
idstring | Mandatory Set as "emptytrash". |
parent_idstring | Mandatory The unique ID of a team folder. |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/actions
{ data: { attributes: { parent_id: "ly9zmacc69de0061b47ad9f09060734858fc4" }, id: "emptytrash", type: "actions" } }
Example Response
{ data: { id: "emptytrash", type: "actions", attributes: { parent_id: "ly9zmacc69de0061b47ad9f09060734858fc4" }, links: { self: "https://www.zohoapis.com/workdrive/actions/emptytrash" } } }
Delete Team Folder
This API deletes a team folder.
Path Parameters
teamfolder_idstring | Mandatory The unique ID of a team folder. |
Example Request
DELETE https://www.zohoapis.com/workdrive/api/v1/teamfolders/{teamfolder_id}
Example Response
204: No Content
Allow Viewer to Download
This API helps in allowing users with a viewer role or view-only access to download files.
Path Parameters
teamfolder_idstring | Mandatory The unique ID of a team folder. |
Request Body Parameters
can_viewer_downloadboolean | Mandatory Setting this "true" will allow the user with a viewer role or view-only access to download files. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/settings/{teamfolder_id}
{ data: { attributes: { can_viewer_download: "true" }, type: "settings" } }
Example Response
{ data: { id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", type: "settings", attributes: { allow_external_sharing: true, data_template_setting: {}, create_file_as_draft: true, allow_ws_to_change_conversion: true, allow_my_folder_to_change_conversion: false, allow_create_ws: 0, email_in: { is_enabled: false, receive_external_mail: false }, is_external_share_enabled: true, enable_org_logo: false, is_document_conversion: false, can_viewer_download: true, setting_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68" }, links: { self: "https://www.zohoapis.com/workdrive/settings/ly9zm0170fb40015f4e2297a144e2b68cfa68" } } }
Show fullEnable Document Conversion
This API will help in enabling automatic conversion of all files to Zoho WorkDrive's format on upload.
Path Parameters
teamfolder_idstring | Mandatory The unique ID of a team folder. |
Request Body Parameters
is_document_conversionboolean | Mandatory Setting this as "true" or "false" will respectively enable or disable automatic conversion of all files to Zoho WorkDrive's format on upload. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/settings/{teamfolder_id}
{ data: { attributes: { is_document_conversion: "true" }, type: "settings" } }
Example Response
{ data: { id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", type: "settings", attributes: { allow_external_sharing: true, data_template_setting: {}, create_file_as_draft: true, allow_ws_to_change_conversion: true, allow_my_folder_to_change_conversion: false, allow_create_ws: 0, email_in: { is_enabled: false, receive_external_mail: false }, is_external_share_enabled: true, enable_org_logo: false, is_document_conversion: true, can_viewer_download: true, setting_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68" }, links: { self: "https://www.zohoapis.com/workdrive/settings/ly9zm0170fb40015f4e2297a144e2b68cfa68" } } }
Show fullTeam Folder Members
Team Folders allows its members to create, upload, edit, and share files and folders to collaborate effectively on complex projects.
The members of the Team Folder are given roles with specific access permissions that help in facilitate a better understanding of what each member can do when work is assigned to them.
Add Members To Team Folder
This API adds already existing team members in a team to the team folder.
Request Body Parameters
resource_idstring | |
shared_typestring | |
email_idstring | |
role_idint |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/members
{ data: { attributes: { resource_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", shared_type: "workspace", email_id: "reyansh.ahuja@zylker.com", role_id: "5" }, type: "members" } }
Example Response
{ data: [ { id: "ly9zm0170fb40015f4e2297a144e2b68cfa68-747938058", type: "members", attributes: { email_id: "reyansh.ahuja@zylker.com", shared_time_in_millis: 1618252163531, shared_by: "Zylker Creation", expiry_in_millis: 0, relation_type: 0, expiration_date: "Jan 1, 1970, 5:30 AM", share_to_entity_info: { display_name: "Zylker Creation", email_id: "reyansh.ahuja@zylker.com", avatar_url: "https://contacts.zoho.com/file?t=user&ID=747938058&fs=thumb&nps=404" }, share_to_member_type: 1, role_id: 5, shared_time_i18: "Apr 12, 11:59 PM", shared_time: "Apr 12, 11:59 PM", shared_status: "INACTIVE", can_link_to_docs: true, owner: "747937818", allow_sharing_outside: false, shared_type: "workspace", delete_from_propagated_space: false, display_name: "Zylker Creation", message: "", share_to: "747938058", is_expired: false, shared_to_member_type: 1, avatar_url: "https://contacts.zoho.com/file?t=user&ID=747938058&fs=thumb&nps=404", is_password_protected: false, resource_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", permalink: "https://www.zohoapis.com/workdrive/file/ly9zm0170fb40015f4e2297a144e2b68cfa68", shared_by_zuid: "747938014" }, links: { self: "https://www.zohoapis.com/workdrive/members/ly9zm0170fb40015f4e2297a144e2b68cfa68-747938058" } } ] }
Show fullAdd Groups to Team Folder
This API will add a WorkDrive Group to the team folder.
Request Body Parameters
resource_idstring | |
shared_typestring | |
role_idint | |
share_tostring |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/members
{ data: { attributes: { resource_id: "8fv34f20c00bf4b6840e4b8b5628fc7750514", shared_type: "groupmembers", role_id: "6", share_to: "lv0t141d6ad9fc3e44dde94b823bae4dcb31b-23000000021001" }, type: "members" } }
Example Response
{ data: [ { id: "8fv34f20c00bf4b6840e4b8b5628fc7750514-23000000021001", type: "members", attributes: { shared_time_in_millis: 1628775758106, shared_by: "Zylker", expiry_in_millis: 0, relation_type: 0, expiration_date: "Jan 1, 1970, 12:00 AM", share_to_entity_info: { display_name: "TestGr", avatar_url: "https://localjs.zohostatic.com/personal/stable/jsapps/ui-lab/dist/assets/dev/svg-icons/common/groups_logo-1b99e1d06fa5e3bb404e335e6ce2f43a.svg", type: 1, collaborators_count: 1 }, share_to_member_type: 1, role_id: 5, shared_time_i18: "Aug 12, 1:42 PM", shared_time: "Aug 12, 1:42 PM", shared_status: "ACTIVE", can_link_to_docs: true, owner: "61236217", allow_sharing_outside: false, shared_type: "groupmembers", shared_to_entity: "TestGr", delete_from_propagated_space: false, display_name: "TestGr", message: "", share_to: "lv0t141d6ad9fc3e44dde94b823bae4dcb31b-23000000021001", is_expired: false, shared_to_member_type: 1, avatar_url: "https://localjs.zohostatic.com/personal/stable/jsapps/ui-lab/dist/assets/dev/svg-icons/common/groups_logo-1b99e1d06fa5e3bb404e335e6ce2f43a.svg", is_password_protected: false, resource_id: "8fv34f20c00bf4b6840e4b8b5628fc7750514", permalink: "https://www.zohoapis.com/workdrive/file/8fv34f20c00bf4b6840e4b8b5628fc7750514", shared_by_zuid: "61220846" }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/members/8fv34f20c00bf4b6840e4b8b5628fc7750514-23000000021001" } } ] }
Show fullUpdate Member Role in Team Folder
This API updates the team folder member's role in a team folder.
There are five different roles for team folder members in a team folder:
Path Parameters
member_idstring | Mandatory The ID that is created when a member is added into a team folder. |
Request Body Parameters
role_idint | Mandatory The ID that represents the role given to the member in the team folder.
|
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/members/{member_id}
{ data: { attributes: { role_id: "2" }, type: "members" } }
Example Response
{ data: { id: "ly9zm0170fb40015f4e2297a144e2b68cfa68-747938058", type: "members", attributes: { email_id: "reyansh.ahuja@zylker.com", shared_time_in_millis: 1618252163531, shared_by: "Zylker Creation", expiry_in_millis: 0, relation_type: 0, expiration_date: "", share_to_entity_info: { display_name: "Zylker Creation", email_id: "reyansh.ahuja@zylker.com", avatar_url: "https://contacts.zoho.com/file?t=user&ID=747938058&fs=thumb&nps=404" }, share_to_member_type: 1, role_id: 2, shared_time_i18: "Apr 12, 11:59 PM", shared_time: "Apr 12, 11:59 PM", shared_status: "INACTIVE", can_link_to_docs: true, owner: "747937818", allow_sharing_outside: false, shared_type: "workspace", delete_from_propagated_space: false, display_name: "Zylker Creation", message: "", share_to: "747938058", is_expired: false, shared_to_member_type: 1, avatar_url: "https://contacts.zoho.com/file?t=user&ID=747938058&fs=thumb&nps=404", is_password_protected: false, resource_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", permalink: "https://www.zohoapis.com/workdrive/file/ly9zm0170fb40015f4e2297a144e2b68cfa68", shared_by_zuid: "747938014" }, links: { self: "https://www.zohoapis.com/workdrive/members/ly9zm0170fb40015f4e2297a144e2b68cfa68-747938058" } } }
Show fullDelete Member from Team Folder
This API deletes members from a team folder.
Path Parameters
member_idstring | Mandatory The ID that is created when a member is added to a team folder. |
Example Request
DELETE https://www.zohoapis.com/workdrive/api/v1/members/{member_id}
Example Response
204: No Content
Files/Folders
A file is an object that stores data, information, settings, or commands used with a computer program. Files are stored in folders.
One can create many team folders for their projects or tasks to store and collaborate on their team's files and folders.
A WorkDrive user can create native files (Document, Spreadsheet, or Presentation) within the WorkDrive account or upload files and folders from the user's desktop, external storage devices, or other cloud resources.
Note:
Only Admins, Organizers, and Editors can add files or folders in a team folder.
Get File/Folder Info
This API fetches basic information about a file or folder within the WorkDrive team .
- With team folders, any team folder member can view the general information of a file.
- With Shared Files, any user can view the files' general information.
Path Parameters
resource_idstring | Mandatory The unique ID of the file/folder. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/files/{resource_id}
Example Response
{ data: { id: "cjrrrd928be6312ac408abe79ec71db3de772", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 0, is_fillable_resource: false, is_published: false, destination_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", storage_info: { size: "128 bytes", storage_used: "128 bytes", files_count: 0, folders_count: 0, size_in_bytes: 128, storage_used_in_bytes: 128 }, type: "file", created_time_i18: "Apr 13, 10:58 AM", modified_time_in_millisecond: 1618291695012, opened_time: "Apr 13, 10:58 AM", status_change_time: "Apr 13, 10:58 AM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/cjrrrd928be6312ac408abe79ec71db3de772", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 13, 10:58 AM", lock_status: 2, is_folder: false, resource_type: 2506, is_email_in_upload: false, display_attr_name: "report april.zip", user_access_time: "Apr 13, 10:58 AM", created_by: "Zylker Creation", display_html_name: "report april.zip", labels: [], user_access_time_i18: "Apr 13, 10:58 AM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", name: "report april.zip", status_change_time_in_millisecond: 1618291695012, permalink: "https://www.zohoapis.com/workdrive/file/cjrrrd928be6312ac408abe79ec71db3de772", 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: "zip", user_access_time_in_millis: 1618291694924, shortcut_link: "", status_change_time_i18: "Apr 13, 10:58 AM", description: "", uploaded_time_in_millisecond: 1618291694928, thumbnail_url: "https://download-accl.zoho.com/v1/workdrive/thumbnail/cjrrrd928be6312ac408abe79ec71db3de772", title: "", modified_time: "Apr 13, 10:58 AM", library_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", icon_class: "zip", created_time_in_millisecond: 1618291694924, owner: "747937818", creator: "747938014", capabilities: { can_read: true, can_share: true, can_remove_share: false, can_delete: false, can_edit: 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: true, can_share_support: true, can_label: true, can_checkout: true, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: 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: 1618291694928, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 13, 10:58 AM", has_folders: false, service_type: "upload", recent_action: "last_modified_time", display_url_name: "report+april.zip", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/files", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/links", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772" } } }
Show fullGet File Thumbnail URL
This API will return all information about a file, which also includes the thumbnail URL of the file.
Path Parameters
resource_idstring | Mandatory The unique ID of the file/folder. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/files/{resource_id}
Example Response
{ data: { id: "cjrrrd928be6312ac408abe79ec71db3de772", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 0, is_fillable_resource: false, is_published: false, destination_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", storage_info: { size: "128 bytes", storage_used: "128 bytes", files_count: 0, folders_count: 0, size_in_bytes: 128, storage_used_in_bytes: 128 }, type: "file", created_time_i18: "Apr 13, 10:58 AM", modified_time_in_millisecond: 1618291695012, opened_time: "Apr 13, 10:58 AM", status_change_time: "Apr 13, 10:58 AM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/cjrrrd928be6312ac408abe79ec71db3de772", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 13, 10:58 AM", lock_status: 2, is_folder: false, resource_type: 2506, is_email_in_upload: false, display_attr_name: "report april.zip", user_access_time: "Apr 13, 10:58 AM", created_by: "Zylker Creation", display_html_name: "report april.zip", labels: [], user_access_time_i18: "Apr 13, 10:58 AM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", name: "report april.zip", status_change_time_in_millisecond: 1618291695012, permalink: "https://www.zohoapis.com/workdrive/file/cjrrrd928be6312ac408abe79ec71db3de772", 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: "zip", user_access_time_in_millis: 1618291694924, shortcut_link: "", status_change_time_i18: "Apr 13, 10:58 AM", description: "", uploaded_time_in_millisecond: 1618291694928, thumbnail_url: "https://download-accl.zoho.com/v1/workdrive/thumbnail/cjrrrd928be6312ac408abe79ec71db3de772", title: "", modified_time: "Apr 13, 10:58 AM", library_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", icon_class: "zip", created_time_in_millisecond: 1618291694924, owner: "747937818", creator: "747938014", capabilities: { can_read: true, can_share: true, can_remove_share: false, can_delete: false, can_edit: 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: true, can_share_support: true, can_label: true, can_checkout: true, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: 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: 1618291694928, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 13, 10:58 AM", has_folders: false, service_type: "upload", recent_action: "last_modified_time", display_url_name: "report+april.zip", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/files", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/links", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772" } } }
Show fullGet File Versions
This API fetches all versions of a file.
Path Parameters
resource_idstring | Mandatory The unique ID of the file. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/files/{resource_id}/versions
Example Response
{ data: [ { id: "cjrrr55b395f872ad4b0a8c52b02eab98c1c5-2774428000000002078", type: "versions", attributes: { created_time: "Apr 13, 3:07 PM", is_locked: false, notes: "Reverted to version 3.0", capabilities: { can_read: true, can_edit: true, can_delete: true }, del_time: -1, created_time_in_milliseconds: 1618306634449, version_number: 5, version_id: 2774428000000002000, created_by: "Zylker Creation", file_size: 92684, file_id: 2774428000000002000, size_in_bytes: "90.0 KB", resource_id: "cjrrr55b395f872ad4b0a8c52b02eab98c1c5" }, links: { self: "https://www.zohoapis.com/workdrive/versions/cjrrr55b395f872ad4b0a8c52b02eab98c1c5-2774428000000002078" } }, { id: "cjrrr55b395f872ad4b0a8c52b02eab98c1c5-2774428000000002076", type: "versions", attributes: { created_time: "Apr 13, 3:06 PM", is_locked: false, notes: "Updated through upload action", capabilities: { can_read: true, can_edit: true, can_delete: true }, del_time: -1, created_time_in_milliseconds: 1618306596243, version_number: 4, version_id: 2774428000000002000, created_by: "Zylker Creation", file_size: 76857, file_id: 2774428000000002000, size_in_bytes: "75.0 KB", resource_id: "cjrrr55b395f872ad4b0a8c52b02eab98c1c5" }, links: { self: "https://www.zohoapis.com/workdrive/versions/cjrrr55b395f872ad4b0a8c52b02eab98c1c5-2774428000000002076" } } ] }
Show fullGet Preview Meta Data
This API fetches all metadata required for previewing the file. This will return the preview URL, preview data URL, and the size of the file.
Path Parameters
resource_idstring | Mandatory The unique ID of the file. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/files/{resource_id}/previewinfo
Example Response
{ data: { id: "cjrrrd928be6312ac408abe79ec71db3de772", type: "previewinfo", attributes: { is_download_server_file: false, isdeveloper_file: false, preview_status: 1, size: "128 bytes", preview_data_url: "https://www.zohoapis.com/workdrive/files/cjrrrd928be6312ac408abe79ec71db3de772/previewzip", preview_url: "https://www.zohoapis.com/workdrive/preview/cjrrrd928be6312ac408abe79ec71db3de772", size_in_bytes: "128", resource_type_modified: false, conversion_size_limit: "2 GB" }, links: { self: "https://www.zohoapis.com/workdrive/previewinfo/cjrrrd928be6312ac408abe79ec71db3de772" } } }
Show fullGet File/Folder Breadcrumbs
This API fetches the current location of the file or folder and the higher-level folders under which the file or folder is stored.
Path Parameters
resource_idstring |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/files/{resource_id}/breadcrumbs
Example Response
{ data: [ { id: "cjrrrd928be6312ac408abe79ec71db3de772-ly9zm0170fb40015f4e2297a144e2b68cfa68", type: "breadcrumbs", attributes: { link_type: "HARDLINK", type: "workspace", parent_ids: [ { name: "Zylker Creation Limited", resource_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", base_parent_id: "-1", res_type: "team" }, { name: "Marketing Details 2021", resource_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", base_parent_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", res_type: "workspace" } ] }, links: { self: "https://www.zohoapis.com/workdrive/breadcrumbs/cjrrrd928be6312ac408abe79ec71db3de772-ly9zm0170fb40015f4e2297a144e2b68cfa68" } } ] }
Show fullGet File Comments
This API lists all the comments from a file.
Path Parameters
resource_idstring | Mandatory The unique ID of the file. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/files/{resource_id}/comments
Example Response
{ data: [ { id: "ly9zm850678101cec4b0698777ab4534a3002-2774428000000002064", type: "comments", attributes: { commented_by: "Zylker Creation", created_time: "Apr 13, 1:24 PM", capabilities: { can_delete_comment: true, can_edit_comment: true, can_replyto_comment: true, can_resolve_comment: true }, commented_email_id: "zylker@zylker.com", modified_email_id: "zylker@zylker.com", comment_html: "Fine", version: "1.0", modified_time: "Apr 13, 1:24 PM", children: [ { data: { id: "ly9zm850678101cec4b0698777ab4534a3002-2774428000000002064", type: "comments", attributes: { commented_by: "Zylker Creation", created_time: "Apr 13, 1:24 PM", capabilities: { can_delete_comment: true, can_edit_comment: true, can_replyto_comment: true, can_resolve_comment: true }, commented_email_id: "zylker@zylker.com", modified_email_id: "zylker@zylker.com", comment_html: "Fine", version: "1.0", modified_time: "Apr 13, 1:24 PM", commented_by_zuid: 747938014, modified_by_zuid: 747938014, modified_by: "Zylker Creation", contacts_url: "https://contacts.zoho.com/file?t=user&ID=747938014&fs=thumb", resource_id: "ly9zm850678101cec4b0698777ab4534a3002", created_time_in_millis: 1618300488998, modified_time_in_millis: 1618300488998, parent_comment_id: "ly9zm850678101cec4b0698777ab4534a3002-2774428000000002063", top_version: true, resolved: false }, links: { self: "https://www.zohoapis.com/workdrive/comments/ly9zm850678101cec4b0698777ab4534a3002-2774428000000002064" } } } ], commented_by_zuid: 747938014, modified_by_zuid: 747938014, modified_by: "Zylker Creation", contacts_url: "https://contacts.zoho.com/file?t=user&ID=747938014&fs=thumb", resource_id: "ly9zm850678101cec4b0698777ab4534a3002", created_time_in_millis: 1618300488998, modified_time_in_millis: 1618300488998, top_version: true, resolved: false }, links: { self: "https://www.zohoapis.com/workdrive/comments/ly9zm850678101cec4b0698777ab4534a3002-2774428000000002064" } } ] }
Show fullGet File/Folder External Share Links
This API fetches the list of all external share links created for a file/folder.
Path Parameters
resource_idstring |
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
filter[type]string | To filter by link type. Eg. filter[type]=download For list of filter type, see Link filter in Filters page, refer here |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/files/{resource_id}/links
Example Response
{ data: [ { id: "3iWUoMURXKC-OCgNc", type: "links", attributes: { modified_time_i18: "Apr 13, 1:16 PM", created_time: "Apr 13, 1:16 PM", file_name: "Notes", link: "https://workdrive.zohoexternal.com/external/3iWUoMURXKC-OCgNc", input_fields: [], type: "folder", can_display_profile: false, created_by: "Zylker Creation", use_shorten_link: false, created_time_i18: "Apr 13, 1:16 PM", allow_download: true, request_user_data: false, link_type: "custom", modified_time: "Apr 13, 1:16 PM", is_expired: false, role_id: 34, download_url: "https://workdrive.zohoexternal.com/external/3iWUoMURXKC-OCgNc/download", is_password_protected: false, modified_by: "Zylker Creation", resource_id: "cjrrr81bad43595d94a5bbbb4ea1589ef9236", created_time_in_millis: 1618299960679, link_name: "notes", modified_time_in_millis: 1618299960679, status: 1 }, relationships: { password: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/relationships/password", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/password" } }, report: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/relationships/report", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/report" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/relationships/timeline", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/timeline" } }, register: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/relationships/register", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/register" } } }, links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc" } } ] }
Show fullGet Shared Users of File
This API fetches all shared users of a file or folder.
Path Parameters
resource_idstring |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/files/{resource_id}/permissions
Example Response
{ data: [ { id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2-747938058", type: "permissions", attributes: { email_id: "reyansh.ahuja@zylker.com", shared_time_in_millis: 1618290356663, shared_by: "Zylker Creation", expiry_in_millis: 0, relation_type: 0, expiration_date: "Jan 1, 1970, 5:30 AM", share_to_entity_info: { display_name: "Zylker Creation", email_id: "reyansh.ahuja@zylker.com", avatar_url: "https://contacts.zoho.com/file?t=user&ID=747938058&fs=thumb&nps=404" }, share_to_member_type: 1, role_id: 5, shared_time_i18: "Apr 13, 10:35 AM", shared_time: "Apr 13, 10:35 AM", shared_status: "ACTIVE", can_link_to_docs: true, owner: "747937818", allow_sharing_outside: false, shared_type: "personal", shared_to_entity: "Zylker Creation", delete_from_propagated_space: false, display_name: "Zylker Creation", message: "", share_to: "747938058", is_expired: false, shared_to_member_type: 1, avatar_url: "https://contacts.zoho.com/file?t=user&ID=747938058&fs=thumb&nps=404", is_password_protected: false, resource_id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", permalink: "https://www.zohoapis.com/workdrive/file/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", shared_by_zuid: "747938014" }, links: { self: "https://www.zohoapis.com/workdrive/permissions/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2-747938058" } } ] }
Show fullGet File/Folder ResourceProperty
This API will return additional properties of the file.
Path Parameters
resource_idstring | Mandatory The unique ID of the file/folder. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/resourceproperty/{resource_id}
Example Response
{ data: { id: "cjrrrd928be6312ac408abe79ec71db3de772", type: "resourceproperty", attributes: { count_info: { preview_count: 0, download_count: 0 }, storage_info: { size: "128 bytes", storage_used: "128 bytes", files_count: 0, folders_count: 0, size_in_bytes: 128, storage_used_in_bytes: 128 } }, links: { self: "https://www.zohoapis.com/workdrive/resourceproperty/cjrrrd928be6312ac408abe79ec71db3de772" } } }
Get File/Folder statistics
This API fetches you complete access stats of the file or folder.
One can view who has accessed your file (both team members and external users) and what actions they have performed (number of views and downloads).
- For both private and public team folders, a member must have the Editor role or higher to view the access stats of a File.
- For shared files, a member must have share permission to view the file access stats.
Path Parameters
resource_idstring | Mandatory The unique ID of the file/folder. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/files/{resource_id}/statistics
Example Response
{ data: { id: "cjrrrd928be6312ac408abe79ec71db3de772", type: "statistics", attributes: { summary: { team_member_view_count: 0, team_member_download_count: 0, team_member_upload_count: 0, external_link_view_count: 0, external_link_download_count: 0, external_link_upload_count: 0, distinct_team_members_count: 0, distinct_external_users_count: 0 }, view_count: 0, download_count: 0 }, relationships: { link_digest: { data: [], links: { self: "https://www.zohoapis.com/workdrive/statistics/cjrrrd928be6312ac408abe79ec71db3de772/relationships/link_digest", related: "https://www.zohoapis.com/workdrive/statistics/cjrrrd928be6312ac408abe79ec71db3de772/link_digest" } } }, links: { self: "https://www.zohoapis.com/workdrive/statistics/cjrrrd928be6312ac408abe79ec71db3de772" } } }
Show fullDownload File
This API returns the file content in binary format. We are supporting a common API for all file type download.
The various domains and their respective download server domain URLs are:
- US: https://download.zoho.com
- AU: https://download.zoho.com.au
- EU: https://download.zoho.eu
- IN: https://download.zoho.in
- CN: https://download.zoho.com.cn
Path Parameters
resource_idstring |
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
versionstring |
Example Request
GET https://download.zoho.com/v1/workdrive/download/{resource_id}
Download Multiple Files/Folders as ZIP
This API downloads multiple files/folders in a compressed ZIP format. It returns wmskey and metadata of the ZIP file that needs to be downloaded.
The WMS key of the particular ZIP can be used in the Multi Download Progress API to retrieve the content of the compressed content.
Request Body Parameters
resource_idstring | Mandatory The unique IDs of the files to be downloaded. |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/multizip
{ data: { attributes: { resource_id: "ly9zm7d2d47e189a041e3be9e64b86e4a79bd,ly9zm4af5c1d02da64bbca3398ab8080a6ba7" }, type: "files" } }
Example Response
{ totalSize: 9293, wmsKey: "TD_DLD_1628776217156", totalFolders: 0, direct_download: true, totalFiles: 2, folderId: "ulzkdcec2f60a582047e391704f8d6aacb70a" }
Multi Download Progress
This API uses the WMS key generated using (returned from) the Download Multiple Files/Folders as ZIP to get the content of the compressed ZIP formatted files.
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
progressidstring | Mandatory WMS Key which returned from Download Multiple Files/Folders as ZIP.
|
Example Request
GET https://www.zohoapis.com/workdrive/downloadprogress?progressid={zuid}_{wms_key_in_api_response}
Example Response
{ RESOURCE_GROUP: "FILE", download_link: "https://download.zoho.com/v1/workdrive/download/5zpiwaa12289891ba4eb29c9c0486855fe32e", OPERATION: "download_progress", docId: "5zpiwaa12289891ba4eb29c9c0486855fe32e", actionId: "TD_DLD_1628776217156", ZUID: "61220846", WMS_SENT_TIME: "1628785094909" }
Upload File
This API uploads a file to a destined team folder or folder in WorkDrive.
- This API will only upload files of size up to 250MB. To upload files more than 250MB, use Upload Large File API.
- We recommend using Chunk File Upload API for files greater than 1 GB in size.
- We have code samples for this API in multiple programming languages.See code samples
- Only admins, organizers, and editors can upload files in a team folder.
Request Body Parameters
filenamestring | Optional The name of the file should be URL encoded with UTF-8 Charset. |
parent_idstring | Mandatory The unique ID of folder where files to be uploaded.
|
override-name-existstring | Optional If set as "true", a file with the matching name will be uploaded as a top version over the existing file. |
contentfile | Mandatory The multi-part file to be uploaded and the maximum file size is 250 MB. |
Based on the status code in response, you can monitor the upload status of files.
Upload Status codes:
- 200 - Returns File Meta in response.
- 400 - Content parameter is missing.
- 401 - Invalid user's credentials/ Parent folder not belong to the user.
- 402 - WorkDrive license is in a suspended state.
- 409 - Same file name already in this Parent folder. File will not be uploaded.
- 413 - File size is greater than 250 MB.
- 500 - An Unknown error occurred
- 507 - User organization storage is full.
- 509 - User's MyFolders storage is full.
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/upload
Example Response
{ data: [ { attributes: { Permalink: "https://www.zohoapis.com/workdrive/file/cjrrr55b395f872ad4b0a8c52b02eab98c1c5", "File INFO": "{"ORG_ID":"6oq3d00e1e07d58c64077b4f1c1f28da4a777","RESOURCE_ID":"cjrrr55b395f872ad4b0a8c52b02eab98c1c5","LIBRARY_ID":"ly9zme5724e019a8e4cb48632945b1296be0a","PARENT_MODEL_ID":"cjrrr81bad43595d94a5bbbb4ea1589ef9236","PARENT_ID":"cjrrr81bad43595d94a5bbbb4ea1589ef9236","RESOURCE_TYPE":2501,"WMS_SENT_TIME":"1618306387346","OWNER":"747937818","RESOURCE_GROUP":"FILE","PARENT_MODEL_NAME":"file","OPERATION":"UPLOAD","EVENT_ID":"-1","AUDIT_INFO":{"resource":{"owner":"747937818","created_time":1618306387229,"creator":"747938014","service_type":4,"extension":"jpg","resource_type":2501,"name":"Capture.JPG"},"parentInfo":{"parentName":"Notes","parentId":"cjrrr81bad43595d94a5bbbb4ea1589ef9236","parentType":1001},"libraryInfo":{"libraryName":"MYSPACE_LIBRARY","libraryId":"ly9zme5724e019a8e4cb48632945b1296be0a","libraryType":20},"statusCode":"D201"},"ZUID":747938014,"TEAM_ID":"ly9zmae16b43c258f458a9a57ac02c4f8d763"}", parent_id: "cjrrr81bad43595d94a5bbbb4ea1589ef9236", FileName: "Capture.JPG", resource_id: "cjrrr55b395f872ad4b0a8c52b02eab98c1c5" }, type: "files" } ] }
Show fullUpload Large File >250MB
By using Upload Server API, you can upload large files of size up to 50 GB based on your WorkDrive edition. In stream mode, files will automatically be split into many small parts and uploaded to the server. The API response will only have details of the successfully uploaded files. To check the failure status of files, you have to use the Upload Progress API.
The various domains and their respective upload server domain URLs are:
- US: https://upload.zoho.com
- AU: https://upload.zoho.com.au
- EU: https://upload.zoho.eu
- IN: https://upload.zoho.in
- CN: https://upload.zoho.com.cn
- We have to send the file content in request body as binary.
- We have code samples for this API in multiple programming languages.See code samples
- We recommend using Chunk File Upload API for files greater than 1 GB in size.
Header Parameters
x-filenamestring | Mandatory The name of the file should be URL encoded with UTF-8 Charset. |
x-parent_idstring | Mandatory The unique ID of the folder where files are to be uploaded. |
upload-idstring | Mandatory unique string - for processing each upload. |
x-streammodestring | Mandatory Default value 1 - for stream mode. |
Example Request
POST https://upload.zoho.com/workdrive-api/v1/stream/upload
Example Response
{ data: [ { attributes: { file_name: "Stats.png", parent_id: "4xbyeb0ea5189975a47619e79810bc57b9816", file_info: "{"ORG_ID":"6oq3d00e1e07d58c64077b4f1c1f28da4a777","RESOURCE_ID":"ouul1ce4c13c372084d0c96c743cdc4b8c519","LIBRARY_ID":"7t3p0f03e370cc4944180afc4d1ce98beaad4","PARENT_MODEL_ID":"4xbyeb0ea5189975a47619e79810bc57b9816","PARENT_ID":"4xbyeb0ea5189975a47619e79810bc57b9816","RESOURCE_TYPE":2501,"WMS_SENT_TIME":"1628785944278","OWNER":"667009621","RESOURCE_GROUP":"FILE","PARENT_MODEL_NAME":"file","size":116420,"OPERATION":"UPLOAD","EVENT_ID":"-1","AUDIT_INFO":{"uploadId":"uploadid11082021957","resource":{"owner":"667009621","created_time":1628785944226,"creator":"668402540","service_type":4,"extension":"png","resource_type":2501,"name":"Stats.png"},"parentInfo":{"parentName":"upload test","parentId":"4xbyeb0ea5189975a47619e79810bc57b9816","parentType":1001},"libraryInfo":{"libraryName":"MYSPACE_LIBRARY","libraryId":"7t3p0f03e370cc4944180afc4d1ce98beaad4","libraryType":20},"statusCode":"D201"},"ZUID":668402540,"TEAM_ID":"6oq3d00e1e07d58c64077b4f1c1f28da4a777"}", resource_id: "ouul1ce4c13c372084d0c96c743cdc4b8c519" }, type: "API_UPLOAD" } ], status: "SUCCESS" }
Show fullUpload Progress
In Upload API (Stream mode), proper error responses will not be shown. You can use the Upload Progress API to get proper error responses using the upload-id value. You can also check if the file upload is in progress or completed. If the upload is completed, you will get a success status with details of the uploaded file.
Note:
If the filename already exists, a duplicate name will be generated automatically.
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
uploadidstring | Mandatory unique string which for processing upload
|
Based on the status code in response, you can monitor the upload status of files.
Upload Status codes:
- D201 - Upload completed successfully.
- D9200 - Upload Failed. Unknown error occurred.
- D9201 - Upload Failed. File is empty (0 byte).
- D9211 - Upload Failed. Storage limit exceeded in your WorkDrive account.
- D9214 - Upload Failed. Invalid Parent ID.
- D9217 - Upload in Progress.
- D9219 - Upload Failed. Invalid credentials or no permission to upload.
- D9102 - Upload Incomplete. Network error occurred or User canceled the upload.
Example Request
GET https://www.zohoapis.com/workdrive/uploadprogress?uploadid=upload_{ZohoUserID}_{upload-id_in_upload_larger_file_API}
Example Response
{ ORG_ID: "6oq3d00e1e07d58c64077b4f1c1f28da4a777", RESOURCE_ID: "ouul1ce4c13c372084d0c96c743cdc4b8c519", LIBRARY_ID: "7t3p0f03e370cc4944180afc4d1ce98beaad4", PARENT_MODEL_ID: "4xbyeb0ea5189975a47619e79810bc57b9816", PARENT_ID: "4xbyeb0ea5189975a47619e79810bc57b9816", RESOURCE_TYPE: 2501, WMS_SENT_TIME: "1628785944278", OWNER: "667009621", RESOURCE_GROUP: "FILE", PARENT_MODEL_NAME: "file", OPERATION: "UPLOAD", EVENT_ID: "-1", AUDIT_INFO: { uploadId: "uploadid11082021957", resource: { owner: "667009621", created_time: 1628785944226, creator: "668402540", service_type: 4, extension: "png", resource_type: 2501, name: "Stats.png" }, parentInfo: { parentName: "upload test", parentId: "4xbyeb0ea5189975a47619e79810bc57b9816", parentType: 1001 }, libraryInfo: { libraryName: "MYSPACE_LIBRARY", libraryId: "7t3p0f03e370cc4944180afc4d1ce98beaad4", libraryType: 20 }, statusCode: "D201" }, ZUID: 668402540, TEAM_ID: "6oq3d00e1e07d58c64077b4f1c1f28da4a777" }
Show fullCreate Zoho format files
This API helps to create Zoho format files, i.e., documents (Zoho Writer), spreadsheets (Zoho Show), and presentations (Zoho Show).
Note:
Only members with Admin, Organizer, and Editor roles can create a file in a team folder.
Request Body Parameters
namestring | Mandatory The name of the new native document/sheet/presentation file. |
service_typestring | Mandatory Allowed service types:
|
parent_idstring | Mandatory The unique ID of the folder/team folder, which will be listed under. |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/files
{ data: { attributes: { name: "ExpensesSheet", service_type: "zohosheet", parent_id: "0nk78318a1771da934f22939e4a00d8aab225" }, type: "files" } }
Example Response
{ data: { id: "cjrrr2b266c68eedd4e6b92e067af9dcc581a", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 0, is_fillable_resource: false, is_published: false, destination_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", 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: "zohosheet", created_time_i18: "Apr 13, 10:39 AM", modified_time_in_millisecond: 1618290568486, opened_time: "Apr 13, 10:39 AM", status_change_time: "Apr 13, 10:39 AM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/cjrrr2b266c68eedd4e6b92e067af9dcc581a", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 13, 10:39 AM", lock_status: 2, is_folder: false, resource_type: 2101, is_email_in_upload: false, display_attr_name: "ExpensesSheet", user_access_time: "Apr 13, 10:39 AM", created_by: "Zylker Creation", display_html_name: "ExpensesSheet", labels: [], user_access_time_i18: "Apr 13, 10:39 AM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", name: "ExpensesSheet", status_change_time_in_millisecond: 1618290568486, permalink: "https://sheet.zoho.com/sheet/open/cjrrr2b266c68eedd4e6b92e067af9dcc581a", favorite: false, new_badge_count: 0, status: 0, modified_time_i18: "Apr 13, 10:39 AM", opened_time_i18: "Apr 13, 10:39 AM", extn: "zsheet", user_access_time_in_millis: 1618290568486, shortcut_link: "", status_change_time_i18: "Apr 13, 10:39 AM", description: "", uploaded_time_in_millisecond: 1618290568489, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/cjrrr2b266c68eedd4e6b92e067af9dcc581a", title: "", modified_time: "Apr 13, 10:39 AM", library_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", icon_class: "sheet", created_time_in_millisecond: 1618290568486, owner: "747937818", creator: "747938014", capabilities: { can_read: true, can_share: true, can_remove_share: false, can_delete: true, can_edit: true, can_upload_files: false, can_trash: false, can_rename: true, can_restore: false, can_copy: false, can_move: false, can_zip: true, can_download: true, can_emailattach: true, can_publish: true, can_create_task: true, can_share_support: true, can_label: true, can_checkout: false, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: true, can_trash_files: false }, uploaded_time_i18: "Apr 13, 10:39 AM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618290568486, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 13, 10:39 AM", has_folders: false, service_type: "zohosheet", recent_action: "last_modified_time", display_url_name: "ExpensesSheet", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/relationships/files", related: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/relationships/links", related: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr2b266c68eedd4e6b92e067af9dcc581a" } } }
Show fullCreate Multiple Files/Folders as ZIP
This API compresses multiple files and folders as a ZIP folder and returns a WMS key.
The WMS key of the particular ZIP can be used in the Create Zip Progress API to retrieve metadata of the compressed content.
Request Body Parameters
resource_idstring | Mandatory The unique IDs of the file/folder, separated by commas. |
namestring | Mandatory The name of the ZIP file. |
destination_idstring | Mandatory The Unique ID of the destination folder. |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/createzip
{ data: { attributes: { resource_id: "jxtee81865c6d7ed64dc596540aa30dfd2753,cjrrr6d1a5111809e4704a025dde678a0c523", name: "reports", destination_id: "6n758918f686c932a45fdbb08a699611761d7" }, type: "files" } }
Example Response
{ totalSize: 260182733, wmsKey: "TD_DLD_1628786173496", direct_zip: true, totalFolders: 0, totalFiles: 2 }
Create ZIP Progress
This API uses the WMS key returned from the Create Multiple Files/Folders as ZIP API to get the metadata of the compressed ZIP file.
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
progressidstring | Mandatory WMS Key, which returned from create multiple files/folders as Zip API |
Example Request
GET https://www.zohoapis.com/workdrive/zipprogress?progressid={zuid}_{wms_key_in_api_response}
Example Response
{ RESOURCE_GROUP: "FILE", OPERATION: "zip_progress", total_files: 2, docId: "", actionId: "TD_DLD_1628786173496", files_done: 0, ZUID: "61220846", WMS_SENT_TIME: "1628786173830" }
Unzip File
This API extract files and folders from a ZIP file to a destined folder in WorkDrive.
Path Parameters
resource_idstring | Mandatory The unique ID of the destination folder where the zip file is extracted to. |
Request Body Parameters
resource_idstring | Mandatory The unique ID of the zip file. |
selected_file_extractionboolean | Mandatory Set value as "false". |
mergestring | Mandatory Set value as "No". |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/files/{resource_id}/unzip
{ data: { attributes: { resource_id: "cjrrr27f73d5b59a54b16aaf3cd74478a0fa2", selected_file_extraction: "false", merge: "no" }, type: "unzip" } }
Example Response
{ data: { id: "cjrrr27f73d5b59a54b16aaf3cd74478a0fa2", type: "unzip", attributes: { selected_file_extraction: false, unzip_info: { name: "report april", id: "cjrrr27f73d5b59a54b16aaf3cd74478a0fa2", children: [ { name: "April", id: "cjrrr1b298cf52cf44acebc713ab5b73bbd77" } ] } }, links: { self: "https://www.zohoapis.com/workdrive/unzip/cjrrr27f73d5b59a54b16aaf3cd74478a0fa2" } } }
Rename File/Folder
This API changes the name of a file or folder.
Path Parameters
resource_idstring | Mandatory The unique ID of the file or folder. |
Request Body Parameters
namestring | Mandatory The new name of the file or folder. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/files/{resource_id}
{ data: { attributes: { name: "User screenshot" }, type: "files" } }
Example Response
{ data: { id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, destination_id: "ly9zme5724e019a8e4cb48632945b1296be0a", storage_info: { size: "48.0 KB", storage_used: "48.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 50081, storage_used_in_bytes: 50081 }, type: "image", created_time_i18: "Apr 12, 9:45 PM", modified_time_in_millisecond: 1618295295764, opened_time: "Apr 12, 9:45 PM", status_change_time: "Apr 13, 11:58 AM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 12, 9:45 PM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "User screenshot.png", user_access_time: "Apr 13, 11:58 AM", created_by: "Zylker Creation", display_html_name: "User screenshot.png", labels: [], user_access_time_i18: "Apr 13, 11:58 AM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a", name: "User screenshot.png", status_change_time_in_millisecond: 1618295295764, permalink: "https://www.zohoapis.com/workdrive/file/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Apr 13, 11:58 AM", opened_time_i18: "Apr 12, 9:45 PM", extn: "png", user_access_time_in_millis: 1618295295764, shortcut_link: "", status_change_time_i18: "Apr 13, 11:58 AM", description: "", uploaded_time_in_millisecond: 1618244132645, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", title: "", modified_time: "Apr 13, 11:58 AM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "img", created_time_in_millisecond: 1618244132643, owner: "747937818", creator: "747938014", capabilities: { can_read: true, can_share: true, can_remove_share: false, can_delete: false, can_edit: 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: true, can_share_support: true, can_label: true, can_checkout: true, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: true, can_trash_files: true }, uploaded_time_i18: "Apr 12, 9:45 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618244132643, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 12, 9:45 PM", has_folders: false, service_type: "upload", recent_action: "last_modified_time", display_url_name: "User+screenshot.png", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2" } } }
Show fullCheck in File
This API will check in the file, which will allow other team members to edit the file and see the changes being made in the file.
Path Parameters
resource_idstring | Mandatory The unique ID of the file/folder. |
Request Body Parameters
lock_statusinteger | Mandatory Allowed value of unlock status:
|
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/files/{resource_id}
{ data: { attributes: { lock_status: "2" }, type: "files" } }
Example Response
{ data: { id: "ly9zm6bfb474b23d945288fd11f123c05843e", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 0, is_fillable_resource: false, is_published: false, collab_id: "2243193149594280833", destination_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", 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: "writer", created_time_i18: "Apr 13, 12:07 AM", modified_time_in_millisecond: 1618252672046, opened_time: "Apr 13, 12:07 AM", status_change_time: "Apr 13, 12:07 AM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/ly9zm6bfb474b23d945288fd11f123c05843e", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 13, 12:07 AM", lock_status: 2, is_folder: false, resource_type: 2001, is_email_in_upload: false, display_attr_name: "Report April Month", user_access_time: "Apr 13, 12:07 AM", created_by: "Zylker Creation", display_html_name: "Report April Month", labels: [], user_access_time_i18: "Apr 13, 12:07 AM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", name: "Report April Month", status_change_time_in_millisecond: 1618252672046, permalink: "https://writer.zoho.com/writer/open/ly9zm6bfb474b23d945288fd11f123c05843e", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Apr 13, 12:07 AM", opened_time_i18: "Apr 13, 12:07 AM", extn: "zwriter", user_access_time_in_millis: 1618252672046, shortcut_link: "", status_change_time_i18: "Apr 13, 12:07 AM", description: "", uploaded_time_in_millisecond: 1618252658914, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm6bfb474b23d945288fd11f123c05843e", title: "", modified_time: "Apr 13, 12:07 AM", library_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", icon_class: "writer", created_time_in_millisecond: 1618252658911, owner: "747937818", creator: "747938014", capabilities: { can_read: true, can_share: true, can_remove_share: false, can_delete: false, can_edit: 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: true, can_share_support: true, can_label: true, can_checkout: true, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: true, can_trash_files: true }, uploaded_time_i18: "Apr 13, 12:07 AM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618252658911, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 13, 12:07 AM", has_folders: false, service_type: "zw", recent_action: "last_modified_time", display_url_name: "Report+April+Month", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e" } } }
Show fullCheck out File
This API will check out a file that will prevent others from editing the file and seeing the changes being made in the file.
Path Parameters
resource_idstring | Mandatory The unique ID of the file/folder. |
Request Body Parameters
lock_statusinteger | Mandatory Allowed value of lock status:
|
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/files/{resource_id}
{ data: { attributes: { lock_status: "1" }, type: "files" } }
Example Response
{ data: { id: "ly9zm6bfb474b23d945288fd11f123c05843e", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: true, conv_engine_type: 0, is_fillable_resource: false, is_published: false, collab_id: "2243193149594280833", destination_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", 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: "writer", created_time_i18: "Apr 13, 12:07 AM", modified_time_in_millisecond: 1618252672046, opened_time: "Apr 13, 12:07 AM", status_change_time: "Apr 13, 12:07 AM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/ly9zm6bfb474b23d945288fd11f123c05843e", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 13, 12:07 AM", lock_status: 1, is_folder: false, resource_type: 2001, is_email_in_upload: false, display_attr_name: "Report April Month", user_access_time: "Apr 13, 12:07 AM", created_by: "Zylker Creation", display_html_name: "Report April Month", labels: [], user_access_time_i18: "Apr 13, 12:07 AM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", name: "Report April Month", status_change_time_in_millisecond: 1618252672046, permalink: "https://writer.zoho.com/writer/open/ly9zm6bfb474b23d945288fd11f123c05843e", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Apr 13, 12:07 AM", opened_time_i18: "Apr 13, 12:07 AM", extn: "zwriter", user_access_time_in_millis: 1618252672046, shortcut_link: "", locked_by_zuid: "747938014", status_change_time_i18: "Apr 13, 12:07 AM", description: "", uploaded_time_in_millisecond: 1618252658914, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm6bfb474b23d945288fd11f123c05843e", title: "", modified_time: "Apr 13, 12:07 AM", library_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", icon_class: "writer", created_time_in_millisecond: 1618252658911, owner: "747937818", creator: "747938014", capabilities: { can_read: true, can_share: true, can_remove_share: false, can_delete: false, can_edit: 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: true, can_share_support: true, can_label: true, can_checkout: false, can_cancel_checkout: true, can_discard_checkout: true, can_checkin: true, can_read_comment: true, can_create_comment: true, can_trash_files: true }, lock_version: "2.0", uploaded_time_i18: "Apr 13, 12:07 AM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618252658911, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 13, 12:07 AM", has_folders: false, service_type: "zw", locked_by: "Zylker Creation", recent_action: "last_modified_time", display_url_name: "Report+April+Month", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e" } } }
Show fullMark File as Ready
Newly created files using Zoho Office Suite (Writer/Sheet/Show) in a Team Folder are called 'Drafts'. Drafts remain invisible to other members in the Team Folder until you mark them as ready.
Path Parameters
resource_idstring | Mandatory The unique ID of the file. |
Request Body Parameters
statusinteger | Mandatory Set the value as "1" to mark the file as ready. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/files/{resource_id}
{ data: { attributes: { status: "1" }, type: "files" } }
Example Response
{ data: { id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, destination_id: "ly9zme5724e019a8e4cb48632945b1296be0a", storage_info: { size: "48.0 KB", storage_used: "48.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 50081, storage_used_in_bytes: 50081 }, type: "image", created_time_i18: "Apr 12, 9:45 PM", modified_time_in_millisecond: 1618295295764, opened_time: "Apr 12, 9:45 PM", status_change_time: "Apr 13, 11:58 AM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 12, 9:45 PM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "User screenshot.png", user_access_time: "Apr 13, 11:58 AM", created_by: "Zylker Creation", display_html_name: "User screenshot.png", labels: [], user_access_time_i18: "Apr 13, 11:58 AM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a", name: "User screenshot.png", status_change_time_in_millisecond: 1618295295764, permalink: "https://www.zohoapis.com/workdrive/file/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Apr 13, 11:58 AM", opened_time_i18: "Apr 12, 9:45 PM", extn: "png", user_access_time_in_millis: 1618295295764, shortcut_link: "", status_change_time_i18: "Apr 13, 11:58 AM", description: "", uploaded_time_in_millisecond: 1618244132645, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", title: "", modified_time: "Apr 13, 11:58 AM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "img", created_time_in_millisecond: 1618244132643, owner: "747937818", creator: "747938014", capabilities: { can_read: true, can_share: true, can_remove_share: false, can_delete: false, can_edit: 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: true, can_share_support: true, can_label: true, can_checkout: true, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: true, can_trash_files: true }, uploaded_time_i18: "Apr 12, 9:45 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618244132643, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 12, 9:45 PM", has_folders: false, service_type: "upload", recent_action: "last_modified_time", display_url_name: "User+screenshot.png", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2" } } }
Show fullConvert File to Zoho Format
This API automatically converts the imported files into the Zoho format, i.e., Writer, Sheet, and Show.
Path Parameters
resource_idstring | Mandatory The unique ID of the imported file. |
Request Body Parameters
resource_idstring | Mandatory The unique ID of the imported file. |
namestring | Mandatory The name of the file. |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/files/{resource_id}/importfile
{ data: { attributes: { resource_id: "d1mlj59afbbdf85bb4cd5b95f8177e4e805dc", name: "worksheet" }, type: "files" } }
Example Response
{ data: [ { id: "d1mljabb238c99b7744a7b7f6259a2bf26390", type: "files", attributes: { modified_by_zuid: "696039393", is_locked: false, conv_engine_type: 0, is_fillable_resource: false, is_published: false, destination_id: "d1mljb8039f3ad8714c6aabcfd8df63dac7f8", 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: "zohosheet", created_time_i18: "Sep 14, 12:34 PM", modified_time_in_millisecond: 1631603092954, opened_time: "Sep 14, 12:34 PM", status_change_time: "Sep 14, 12:34 PM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/d1mljabb238c99b7744a7b7f6259a2bf26390", comment_badge_count: 0, is_app_associated: false, created_time: "Sep 14, 12:34 PM", lock_status: 2, is_folder: false, resource_type: 2101, is_email_in_upload: false, display_attr_name: "worksheet", created_by: "Mohammed", display_html_name: "worksheet", labels: [], org_id: "ge60277a7b25a570f4720b10d2f5f57cc83b0", parent_id: "d1mljb8039f3ad8714c6aabcfd8df63dac7f8", name: "worksheet", status_change_time_in_millisecond: 1631603092954, permalink: "https://sheet.zoho.com/sheet/open/d1mljabb238c99b7744a7b7f6259a2bf26390", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Sep 14, 12:34 PM", opened_time_i18: "Sep 14, 12:34 PM", extn: "xlsx", shortcut_link: "", status_change_time_i18: "Sep 14, 12:34 PM", description: "", uploaded_time_in_millisecond: 1631603092542, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/d1mljabb238c99b7744a7b7f6259a2bf26390", title: "", modified_time: "Sep 14, 12:34 PM", library_id: "d1mljb8039f3ad8714c6aabcfd8df63dac7f8", icon_class: "sheet", created_time_in_millisecond: 1631603092542, owner: "696070234", creator: "696039393", capabilities: { can_read: true, can_share: true, can_remove_share: false, can_delete: false, can_edit: 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: true, can_share_support: true, can_label: true, can_delist_file: false, can_associate_data_template: true, can_favorite: true, can_checkout: true, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: true, can_trash_files: true }, uploaded_time_i18: "Sep 14, 12:34 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1631603092542, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Sep 14, 12:34 PM", has_folders: false, service_type: "zohosheet", display_url_name: "worksheet", is_unread: false, modified_by: "Mohammed", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/folders", related: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/folders" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/unzip", related: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/unzip" } }, accesschartdata: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/accesschartdata", related: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/accesschartdata" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/resourceproperty" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/importfile", related: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/importfile" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/permissions", related: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/permissions" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/links", related: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/copy", related: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/tasks", related: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/tasks" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/custommetadata" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/comments", related: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/previewinfo" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/publiclink" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/parentfolders" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/versions", related: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/supportshare" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/timeline", related: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/files", related: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/files" } }, accessdata: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/accessdata", related: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/accessdata" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/entity", related: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/entity" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/statistics", related: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/appdata", related: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390" } } ] }
Show fullCopy File/Folder
This API copies a file or folder from one destination to another.
Path Parameters
resource_idstring | Mandatory The unique ID of the destination folder. |
Request Body Parameters
resource_idstring | Mandatory The unique ID of the source file or folder. |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/files/{resource_id}/copy
{ data: { attributes: { resource_id: "jxtee81865c6d7ed64dc596540aa30dfd2753" }, type: "files" } }
Example Response
{ data: [ { id: "jxtee2f2b3ba636c542119b14bd1a105aa73c", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 0, is_fillable_resource: false, is_published: false, destination_id: "ly9zm3bd32ac7cfdd45448e435bd20a6be500", storage_info: { files_count: 0, folders_count: 0, size_in_bytes: 0, storage_used_in_bytes: 0 }, type: "file", created_time_i18: "Apr 14, 4:59 PM", modified_time_in_millisecond: 1618400166972, opened_time: "Apr 14, 5:06 PM", status_change_time: "Apr 14, 5:06 PM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/jxtee2f2b3ba636c542119b14bd1a105aa73c", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 14, 4:59 PM", lock_status: 2, is_folder: false, resource_type: 2506, is_email_in_upload: false, display_attr_name: "reports.zip", user_access_time: "Apr 14, 4:59 PM", created_by: "Zylker Creation", display_html_name: "reports.zip", labels: [], user_access_time_i18: "Apr 14, 4:59 PM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zm3bd32ac7cfdd45448e435bd20a6be500", name: "reports.zip", status_change_time_in_millisecond: 1618400166972, permalink: "https://www.zohoapis.com/workdrive/file/jxtee2f2b3ba636c542119b14bd1a105aa73c", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Apr 14, 5:06 PM", opened_time_i18: "Apr 14, 5:06 PM", extn: "zip", user_access_time_in_millis: 1618399762132, shortcut_link: "", status_change_time_i18: "Apr 14, 5:06 PM", description: "", uploaded_time_in_millisecond: 1618400166895, thumbnail_url: "https://download-accl.zoho.com/v1/workdrive/thumbnail/jxtee2f2b3ba636c542119b14bd1a105aa73c", title: "", modified_time: "Apr 14, 5:06 PM", library_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", icon_class: "zip", created_time_in_millisecond: 1618399761943, owner: "747937818", creator: "747938014", capabilities: { can_read: true, can_share: true, can_remove_share: false, can_delete: false, can_edit: 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: true, can_share_support: true, can_label: true, can_delist_file: false, can_checkout: true, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: true, can_trash_files: true }, uploaded_time_i18: "Apr 14, 5:06 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618400166895, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 14, 5:06 PM", has_folders: false, service_type: "upload", recent_action: "last_modified_time", display_url_name: "reports.zip", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/relationships/files", related: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/relationships/links", related: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/jxtee2f2b3ba636c542119b14bd1a105aa73c" } } ], meta: { search_result_count: 0, action_id: "2774428000000022007" } }
Show fullCopy Multiple Files/Folders
This API copies a collection of files or folders from one destination to another.
Path Parameters
resource_idstring | Mandatory The unique ID of the destination folder. |
Request Body Parameters
resource_idstring | Mandatory The unique ID of the source file/folder. |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/files/{resource_id}/copy
{ data: [ { attributes: { resource_id: "jxtee81865c6d7ed64dc596540aa30dfd2753" }, type: "files" }, { attributes: { resource_id: "cjrrr6d1a5111809e4704a025dde678a0c523" }, type: "files" } ] }
Example Response
{ data: [ { id: "jxtee09768648f1d4494c94294fddfe4dc0b7", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 0, is_fillable_resource: false, is_published: false, destination_id: "ly9zm3bd32ac7cfdd45448e435bd20a6be500", storage_info: { files_count: 0, folders_count: 0, size_in_bytes: 0, storage_used_in_bytes: 0 }, type: "file", created_time_i18: "Apr 14, 4:59 PM", modified_time_in_millisecond: 1618400374394, opened_time: "Apr 14, 5:09 PM", status_change_time: "Apr 14, 5:09 PM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/jxtee09768648f1d4494c94294fddfe4dc0b7", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 14, 4:59 PM", lock_status: 2, is_folder: false, resource_type: 2506, is_email_in_upload: false, display_attr_name: "Copy of reports.zip", user_access_time: "Apr 14, 4:59 PM", created_by: "Zylker Creation", display_html_name: "Copy of reports.zip", labels: [], user_access_time_i18: "Apr 14, 4:59 PM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zm3bd32ac7cfdd45448e435bd20a6be500", name: "Copy of reports.zip", status_change_time_in_millisecond: 1618400374394, permalink: "https://www.zohoapis.com/workdrive/file/jxtee09768648f1d4494c94294fddfe4dc0b7", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Apr 14, 5:09 PM", opened_time_i18: "Apr 14, 5:09 PM", extn: "zip", user_access_time_in_millis: 1618399762132, shortcut_link: "", status_change_time_i18: "Apr 14, 5:09 PM", description: "", uploaded_time_in_millisecond: 1618400374335, thumbnail_url: "https://download-accl.zoho.com/v1/workdrive/thumbnail/jxtee09768648f1d4494c94294fddfe4dc0b7", title: "", modified_time: "Apr 14, 5:09 PM", library_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", icon_class: "zip", created_time_in_millisecond: 1618399761943, owner: "747937818", creator: "747938014", capabilities: { can_read: true, can_share: true, can_remove_share: false, can_delete: false, can_edit: 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: true, can_share_support: true, can_label: true, can_delist_file: false, can_checkout: true, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: true, can_trash_files: true }, uploaded_time_i18: "Apr 14, 5:09 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618400374335, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 14, 5:09 PM", has_folders: false, service_type: "upload", recent_action: "last_modified_time", display_url_name: "Copy+of+reports.zip", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/relationships/files", related: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/relationships/links", related: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/jxtee09768648f1d4494c94294fddfe4dc0b7" } }, { id: "jxteee36117a7050b4a31b99f8d71c4ef3331", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, destination_id: "ly9zm3bd32ac7cfdd45448e435bd20a6be500", storage_info: { files_count: 0, folders_count: 0, size_in_bytes: 0, storage_used_in_bytes: 0 }, type: "image", created_time_i18: "Apr 13, 12:13 PM", modified_time_in_millisecond: 1618400374497, opened_time: "Apr 14, 5:09 PM", status_change_time: "Apr 14, 5:09 PM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/jxteee36117a7050b4a31b99f8d71c4ef3331", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 13, 12:13 PM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "Screenshot from 2021-04-09 11-30-24.png", user_access_time: "Apr 13, 12:13 PM", created_by: "Zylker Creation", display_html_name: "Screenshot from 2021-04-09 11-30-24.png", labels: [], user_access_time_i18: "Apr 13, 12:13 PM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zm3bd32ac7cfdd45448e435bd20a6be500", name: "Screenshot from 2021-04-09 11-30-24.png", status_change_time_in_millisecond: 1618400374497, permalink: "https://www.zohoapis.com/workdrive/file/jxteee36117a7050b4a31b99f8d71c4ef3331", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Apr 14, 5:09 PM", opened_time_i18: "Apr 14, 5:09 PM", extn: "png", user_access_time_in_millis: 1618296234068, shortcut_link: "", status_change_time_i18: "Apr 14, 5:09 PM", description: "", uploaded_time_in_millisecond: 1618400374436, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/jxteee36117a7050b4a31b99f8d71c4ef3331", title: "", modified_time: "Apr 14, 5:09 PM", library_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", icon_class: "img", created_time_in_millisecond: 1618296234068, owner: "747937818", creator: "747938014", capabilities: { can_read: true, can_share: true, can_remove_share: false, can_delete: false, can_edit: 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: true, can_share_support: true, can_label: true, can_delist_file: false, can_checkout: true, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: true, can_trash_files: true }, uploaded_time_i18: "Apr 14, 5:09 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618400374436, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 14, 5:09 PM", has_folders: false, service_type: "upload", recent_action: "last_modified_time", display_url_name: "Screenshot+from+2021-04-09+11-30-24.png", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/relationships/files", related: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/relationships/links", related: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/jxteee36117a7050b4a31b99f8d71c4ef3331" } } ], meta: { search_result_count: 0, action_id: "2774428000000022011" } }
Show fullMove File/Folder
This API moves a file or folder to a new destination folder in WorkDrive.
Path Parameters
resource_idstring | Mandatory The unique ID of the file. |
Request Body Parameters
parent_idstring | Mandatory The unique ID of the destination folder. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/files/{resource_id}
{ data: { attributes: { parent_id: "0nk78318a1771da934f22939e4a00d8aab225" }, type: "files" } }
Example Response
{ data: [ { id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, collab_id: "2243193151340634610", destination_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", storage_info: { size: "48.0 KB", storage_used: "48.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 50081, storage_used_in_bytes: 50081 }, type: "image", created_time_i18: "Apr 12, 9:45 PM", modified_time_in_millisecond: 1618295295764, opened_time: "Apr 12, 9:45 PM", status_change_time: "Apr 13, 11:58 AM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 12, 9:45 PM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "User screenshot.png", user_access_time: "Apr 13, 11:58 AM", created_by: "Zylker Creation", display_html_name: "User screenshot.png", labels: [], user_access_time_i18: "Apr 13, 11:58 AM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", name: "User screenshot.png", status_change_time_in_millisecond: 1618295295764, permalink: "https://www.zohoapis.com/workdrive/file/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Apr 13, 11:58 AM", opened_time_i18: "Apr 12, 9:45 PM", extn: "png", user_access_time_in_millis: 1618295295764, shortcut_link: "", status_change_time_i18: "Apr 13, 11:58 AM", description: "", uploaded_time_in_millisecond: 1618244132645, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", title: "", modified_time: "Apr 13, 11:58 AM", library_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", icon_class: "img", created_time_in_millisecond: 1618244132643, owner: "747937818", creator: "747938014", capabilities: { can_read: true, can_share: true, can_remove_share: false, can_delete: false, can_edit: 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: true, can_share_support: true, can_label: true, can_checkout: true, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: true, can_trash_files: true }, uploaded_time_i18: "Apr 12, 9:45 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618244132643, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 12, 9:45 PM", has_folders: false, service_type: "upload", recent_action: "last_modified_time", display_url_name: "User+screenshot.png", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2" } } ], meta: { search_result_count: 0, action_id: "2774428000000002046" } }
Show fullMove Multiple Files/Folders
This API moves multiple files or folders to a new destination folder in WorkDrive.
Request Body Parameters
idstring | Mandatory The unique ID of the file/folder. |
parent_idstring | Mandatory The unique ID of the destination folder. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/files
{ data: [ { attributes: { parent_id: "6n758918f686c932a45fdbb08a699611761d7" }, id: "cjrrr34b357f853fc4db6aba39534b444efa6", type: "files" }, { attributes: { parent_id: "6n758918f686c932a45fdbb08a699611761d7" }, id: "cjrrr6d1a5111809e4704a025dde678a0c523", type: "files" } ] }
Example Response
{ data: [ { id: "cjrrr34b357f853fc4db6aba39534b444efa6", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, destination_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", storage_info: { size: "48.0 KB", storage_used: "48.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 50081, storage_used_in_bytes: 50081 }, type: "image", created_time_i18: "Apr 13, 12:13 PM", modified_time_in_millisecond: 1618296234065, opened_time: "Apr 13, 12:13 PM", status_change_time: "Apr 13, 12:13 PM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/cjrrr34b357f853fc4db6aba39534b444efa6", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 13, 12:13 PM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "Screenshot from 2021-03-22 10-40-22.png", user_access_time: "Apr 13, 12:13 PM", created_by: "Zylker Creation", display_html_name: "Screenshot from 2021-03-22 10-40-22.png", labels: [], user_access_time_i18: "Apr 13, 12:13 PM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", name: "Screenshot from 2021-03-22 10-40-22.png", status_change_time_in_millisecond: 1618296234065, permalink: "https://www.zohoapis.com/workdrive/file/cjrrr34b357f853fc4db6aba39534b444efa6", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Apr 13, 12:13 PM", opened_time_i18: "Apr 13, 12:13 PM", extn: "png", user_access_time_in_millis: 1618296234065, shortcut_link: "", status_change_time_i18: "Apr 13, 12:13 PM", description: "", uploaded_time_in_millisecond: 1618296234069, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/cjrrr34b357f853fc4db6aba39534b444efa6", title: "", modified_time: "Apr 13, 12:13 PM", library_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", icon_class: "img", created_time_in_millisecond: 1618296234065, owner: "747937818", creator: "747938014", capabilities: { can_read: true, can_share: true, can_remove_share: false, can_delete: false, can_edit: 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: true, can_share_support: true, can_label: true, can_checkout: true, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: true, can_trash_files: true }, uploaded_time_i18: "Apr 13, 12:13 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618296234065, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 13, 12:13 PM", has_folders: false, service_type: "upload", recent_action: "last_modified_time", display_url_name: "Screenshot+from+2021-03-22+10-40-22.png", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/relationships/files", related: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/relationships/links", related: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr34b357f853fc4db6aba39534b444efa6" } }, { id: "cjrrr6d1a5111809e4704a025dde678a0c523", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, destination_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", storage_info: { size: "92.0 KB", storage_used: "92.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 94427, storage_used_in_bytes: 94427 }, type: "image", created_time_i18: "Apr 13, 12:13 PM", modified_time_in_millisecond: 1618296234068, opened_time: "Apr 13, 12:13 PM", status_change_time: "Apr 13, 12:13 PM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/cjrrr6d1a5111809e4704a025dde678a0c523", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 13, 12:13 PM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "Screenshot from 2021-04-09 11-30-24.png", user_access_time: "Apr 13, 12:13 PM", created_by: "Zylker Creation", display_html_name: "Screenshot from 2021-04-09 11-30-24.png", labels: [], user_access_time_i18: "Apr 13, 12:13 PM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", name: "Screenshot from 2021-04-09 11-30-24.png", status_change_time_in_millisecond: 1618296234068, permalink: "https://www.zohoapis.com/workdrive/file/cjrrr6d1a5111809e4704a025dde678a0c523", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Apr 13, 12:13 PM", opened_time_i18: "Apr 13, 12:13 PM", extn: "png", user_access_time_in_millis: 1618296234068, shortcut_link: "", status_change_time_i18: "Apr 13, 12:13 PM", description: "", uploaded_time_in_millisecond: 1618296234071, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/cjrrr6d1a5111809e4704a025dde678a0c523", title: "", modified_time: "Apr 13, 12:13 PM", library_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", icon_class: "img", created_time_in_millisecond: 1618296234068, owner: "747937818", creator: "747938014", capabilities: { can_read: true, can_share: true, can_remove_share: false, can_delete: false, can_edit: 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: true, can_share_support: true, can_label: true, can_checkout: true, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: true, can_trash_files: true }, uploaded_time_i18: "Apr 13, 12:13 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618296234068, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 13, 12:13 PM", has_folders: false, service_type: "upload", recent_action: "last_modified_time", display_url_name: "Screenshot+from+2021-04-09+11-30-24.png", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/relationships/files", related: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/relationships/links", related: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr6d1a5111809e4704a025dde678a0c523" } } ], meta: { search_result_count: 0, action_id: "2774428000000002056" } }
Show fullMark File/Folder as Favorites
This API marks a file or a folder as favorites. You can add frequently used or important files to favorites so that you can easily access them.
Path Parameters
resource_idstring | Mandatory The unique ID of the file/folder. |
Request Body Parameters
favoriteboolean | Mandatory Set as "true" to remove the file from favorites. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/files/{resource_id}
{ data: { attributes: { favorite: "true" }, type: "files" } }
Example Response
{ data: [ { id: "ly9zm3c10f18ca7e3422db10f5b335d33b0cc", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, destination_id: "ly9zme5724e019a8e4cb48632945b1296be0a", storage_info: { size: "92.0 KB", storage_used: "92.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 94427, storage_used_in_bytes: 94427 }, type: "image", created_time_i18: "Apr 12, 9:45 PM", modified_time_in_millisecond: 1618244131914, opened_time: "Apr 12, 9:45 PM", status_change_time: "Apr 12, 9:45 PM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/ly9zm3c10f18ca7e3422db10f5b335d33b0cc", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 12, 9:45 PM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "Screenshot from 2021-04-09 11-30-24.png", user_access_time: "Apr 12, 9:45 PM", created_by: "Zylker Creation", display_html_name: "Screenshot from 2021-04-09 11-30-24.png", labels: [], user_access_time_i18: "Apr 12, 9:45 PM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a", name: "Screenshot from 2021-04-09 11-30-24.png", status_change_time_in_millisecond: 1618244131914, permalink: "https://www.zohoapis.com/workdrive/file/ly9zm3c10f18ca7e3422db10f5b335d33b0cc", favorite: true, new_badge_count: 0, status: 1, modified_time_i18: "Apr 12, 9:45 PM", opened_time_i18: "Apr 12, 9:45 PM", extn: "png", user_access_time_in_millis: 1618244131914, shortcut_link: "", status_change_time_i18: "Apr 12, 9:45 PM", description: "", uploaded_time_in_millisecond: 1618244131917, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm3c10f18ca7e3422db10f5b335d33b0cc", title: "", modified_time: "Apr 12, 9:45 PM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "img", created_time_in_millisecond: 1618244131914, owner: "747937818", creator: "747938014", capabilities: { can_read: true, can_share: true, can_remove_share: false, can_delete: false, can_edit: 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: true, can_share_support: true, can_label: true, can_checkout: true, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: true, can_trash_files: true }, uploaded_time_i18: "Apr 12, 9:45 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618244131914, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 12, 9:45 PM", has_folders: false, service_type: "upload", recent_action: "last_modified_time", display_url_name: "Screenshot+from+2021-04-09+11-30-24.png", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc" } } ], meta: { search_result_count: 0, action_id: "2774428000000002038" } }
Show fullMark Multiple Files/Folders as Favorites
This API marks the selected files and/or folders as favorites.
Request Body Parameters
idstring | Mandatory The unique ID of the file/folder. |
favoriteboolean | Mandatory Set as "true" to remove the file from favorites. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/files
{ data: [ { attributes: { favorite: "true" }, id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", type: "files" }, { attributes: { favorite: "true" }, id: "ly9zm3c10f18ca7e3422db10f5b335d33b0cc", type: "files" } ] }
Example Response
{ data: [ { id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, destination_id: "ly9zme5724e019a8e4cb48632945b1296be0a", storage_info: { size: "48.0 KB", storage_used: "48.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 50081, storage_used_in_bytes: 50081 }, type: "image", created_time_i18: "Apr 12, 9:45 PM", modified_time_in_millisecond: 1618244132643, opened_time: "Apr 12, 9:45 PM", status_change_time: "Apr 12, 9:45 PM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 12, 9:45 PM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "Screenshot from 2021-03-22 10-40-22.png", user_access_time: "Apr 12, 9:45 PM", created_by: "Zylker Creation", display_html_name: "Screenshot from 2021-03-22 10-40-22.png", labels: [], user_access_time_i18: "Apr 12, 9:45 PM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a", name: "Screenshot from 2021-03-22 10-40-22.png", status_change_time_in_millisecond: 1618244132643, permalink: "https://www.zohoapis.com/workdrive/file/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", favorite: true, new_badge_count: 0, status: 1, modified_time_i18: "Apr 12, 9:45 PM", opened_time_i18: "Apr 12, 9:45 PM", extn: "png", user_access_time_in_millis: 1618244132643, shortcut_link: "", status_change_time_i18: "Apr 12, 9:45 PM", description: "", uploaded_time_in_millisecond: 1618244132645, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", title: "", modified_time: "Apr 12, 9:45 PM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "img", created_time_in_millisecond: 1618244132643, owner: "747937818", creator: "747938014", capabilities: { can_read: true, can_share: true, can_remove_share: false, can_delete: false, can_edit: 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: true, can_share_support: true, can_label: true, can_checkout: true, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: true, can_trash_files: true }, uploaded_time_i18: "Apr 12, 9:45 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618244132643, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 12, 9:45 PM", has_folders: false, service_type: "upload", recent_action: "last_modified_time", display_url_name: "Screenshot+from+2021-03-22+10-40-22.png", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2" } }, { id: "ly9zm3c10f18ca7e3422db10f5b335d33b0cc", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, destination_id: "ly9zme5724e019a8e4cb48632945b1296be0a", storage_info: { size: "92.0 KB", storage_used: "92.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 94427, storage_used_in_bytes: 94427 }, type: "image", created_time_i18: "Apr 12, 9:45 PM", modified_time_in_millisecond: 1618244131914, opened_time: "Apr 12, 9:45 PM", status_change_time: "Apr 12, 9:45 PM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/ly9zm3c10f18ca7e3422db10f5b335d33b0cc", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 12, 9:45 PM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "Screenshot from 2021-04-09 11-30-24.png", user_access_time: "Apr 12, 9:45 PM", created_by: "Zylker Creation", display_html_name: "Screenshot from 2021-04-09 11-30-24.png", labels: [], user_access_time_i18: "Apr 12, 9:45 PM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a", name: "Screenshot from 2021-04-09 11-30-24.png", status_change_time_in_millisecond: 1618244131914, permalink: "https://www.zohoapis.com/workdrive/file/ly9zm3c10f18ca7e3422db10f5b335d33b0cc", favorite: true, new_badge_count: 0, status: 1, modified_time_i18: "Apr 12, 9:45 PM", opened_time_i18: "Apr 12, 9:45 PM", extn: "png", user_access_time_in_millis: 1618244131914, shortcut_link: "", status_change_time_i18: "Apr 12, 9:45 PM", description: "", uploaded_time_in_millisecond: 1618244131917, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm3c10f18ca7e3422db10f5b335d33b0cc", title: "", modified_time: "Apr 12, 9:45 PM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "img", created_time_in_millisecond: 1618244131914, owner: "747937818", creator: "747938014", capabilities: { can_read: true, can_share: true, can_remove_share: false, can_delete: false, can_edit: 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: true, can_share_support: true, can_label: true, can_checkout: true, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: true, can_trash_files: true }, uploaded_time_i18: "Apr 12, 9:45 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618244131914, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 12, 9:45 PM", has_folders: false, service_type: "upload", recent_action: "last_modified_time", display_url_name: "Screenshot+from+2021-04-09+11-30-24.png", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc" } } ], meta: { search_result_count: 0, action_id: "2774428000000002034" } }
Show fullRemove File/Folder from Favorites
This API removes a file or folder from the favorites section.
Path Parameters
resource_idstring | Mandatory The unique ID of the file/folder. |
Request Body Parameters
favoriteboolean | Mandatory Set as "false" to remove from favorites. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/files/{resource_id}
{ data: { attributes: { favorite: "false" }, type: "files" } }
Example Response
{ data: [ { id: "ly9zm3c10f18ca7e3422db10f5b335d33b0cc", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, destination_id: "ly9zme5724e019a8e4cb48632945b1296be0a", storage_info: { size: "92.0 KB", storage_used: "92.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 94427, storage_used_in_bytes: 94427 }, type: "image", created_time_i18: "Apr 12, 9:45 PM", modified_time_in_millisecond: 1618244131914, opened_time: "Apr 12, 9:45 PM", status_change_time: "Apr 12, 9:45 PM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/ly9zm3c10f18ca7e3422db10f5b335d33b0cc", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 12, 9:45 PM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "Screenshot from 2021-04-09 11-30-24.png", user_access_time: "Apr 12, 9:45 PM", created_by: "Zylker Creation", display_html_name: "Screenshot from 2021-04-09 11-30-24.png", labels: [], user_access_time_i18: "Apr 12, 9:45 PM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a", name: "Screenshot from 2021-04-09 11-30-24.png", status_change_time_in_millisecond: 1618244131914, permalink: "https://www.zohoapis.com/workdrive/file/ly9zm3c10f18ca7e3422db10f5b335d33b0cc", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Apr 12, 9:45 PM", opened_time_i18: "Apr 12, 9:45 PM", extn: "png", user_access_time_in_millis: 1618244131914, shortcut_link: "", status_change_time_i18: "Apr 12, 9:45 PM", description: "", uploaded_time_in_millisecond: 1618244131917, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm3c10f18ca7e3422db10f5b335d33b0cc", title: "", modified_time: "Apr 12, 9:45 PM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "img", created_time_in_millisecond: 1618244131914, owner: "747937818", creator: "747938014", capabilities: { can_read: true, can_share: true, can_remove_share: false, can_delete: false, can_edit: 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: true, can_share_support: true, can_label: true, can_checkout: true, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: true, can_trash_files: true }, uploaded_time_i18: "Apr 12, 9:45 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618244131914, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 12, 9:45 PM", has_folders: false, service_type: "upload", recent_action: "last_modified_time", display_url_name: "Screenshot+from+2021-04-09+11-30-24.png", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc" } } ], meta: { search_result_count: 0, action_id: "2774428000000002040" } }
Show fullRemove Multiple Files/Folders from Favorites
This API removes the selected files and folders from the favorites section.
Request Body Parameters
idstring | Mandatory The unique ID of the file/folder. |
favoriteboolean | Mandatory Set as "false" to remove from favorites. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/files
{ data: [ { attributes: { favorite: "false" }, id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", type: "files" }, { attributes: { favorite: "false" }, id: "ly9zm3c10f18ca7e3422db10f5b335d33b0cc", type: "files" } ] }
Example Response
{ data: [ { id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, destination_id: "ly9zme5724e019a8e4cb48632945b1296be0a", storage_info: { size: "48.0 KB", storage_used: "48.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 50081, storage_used_in_bytes: 50081 }, type: "image", created_time_i18: "Apr 12, 9:45 PM", modified_time_in_millisecond: 1618244132643, opened_time: "Apr 12, 9:45 PM", status_change_time: "Apr 12, 9:45 PM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 12, 9:45 PM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "Screenshot from 2021-03-22 10-40-22.png", user_access_time: "Apr 12, 9:45 PM", created_by: "Zylker Creation", display_html_name: "Screenshot from 2021-03-22 10-40-22.png", labels: [], user_access_time_i18: "Apr 12, 9:45 PM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a", name: "Screenshot from 2021-03-22 10-40-22.png", status_change_time_in_millisecond: 1618244132643, permalink: "https://www.zohoapis.com/workdrive/file/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Apr 12, 9:45 PM", opened_time_i18: "Apr 12, 9:45 PM", extn: "png", user_access_time_in_millis: 1618244132643, shortcut_link: "", status_change_time_i18: "Apr 12, 9:45 PM", description: "", uploaded_time_in_millisecond: 1618244132645, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", title: "", modified_time: "Apr 12, 9:45 PM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "img", created_time_in_millisecond: 1618244132643, owner: "747937818", creator: "747938014", capabilities: { can_read: true, can_share: true, can_remove_share: false, can_delete: false, can_edit: 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: true, can_share_support: true, can_label: true, can_checkout: true, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: true, can_trash_files: true }, uploaded_time_i18: "Apr 12, 9:45 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618244132643, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 12, 9:45 PM", has_folders: false, service_type: "upload", recent_action: "last_modified_time", display_url_name: "Screenshot+from+2021-03-22+10-40-22.png", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2" } }, { id: "ly9zm3c10f18ca7e3422db10f5b335d33b0cc", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, destination_id: "ly9zme5724e019a8e4cb48632945b1296be0a", storage_info: { size: "92.0 KB", storage_used: "92.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 94427, storage_used_in_bytes: 94427 }, type: "image", created_time_i18: "Apr 12, 9:45 PM", modified_time_in_millisecond: 1618244131914, opened_time: "Apr 12, 9:45 PM", status_change_time: "Apr 12, 9:45 PM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/ly9zm3c10f18ca7e3422db10f5b335d33b0cc", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 12, 9:45 PM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "Screenshot from 2021-04-09 11-30-24.png", user_access_time: "Apr 12, 9:45 PM", created_by: "Zylker Creation", display_html_name: "Screenshot from 2021-04-09 11-30-24.png", labels: [], user_access_time_i18: "Apr 12, 9:45 PM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a", name: "Screenshot from 2021-04-09 11-30-24.png", status_change_time_in_millisecond: 1618244131914, permalink: "https://www.zohoapis.com/workdrive/file/ly9zm3c10f18ca7e3422db10f5b335d33b0cc", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Apr 12, 9:45 PM", opened_time_i18: "Apr 12, 9:45 PM", extn: "png", user_access_time_in_millis: 1618244131914, shortcut_link: "", status_change_time_i18: "Apr 12, 9:45 PM", description: "", uploaded_time_in_millisecond: 1618244131917, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm3c10f18ca7e3422db10f5b335d33b0cc", title: "", modified_time: "Apr 12, 9:45 PM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "img", created_time_in_millisecond: 1618244131914, owner: "747937818", creator: "747938014", capabilities: { can_read: true, can_share: true, can_remove_share: false, can_delete: false, can_edit: 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: true, can_share_support: true, can_label: true, can_checkout: true, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: true, can_trash_files: true }, uploaded_time_i18: "Apr 12, 9:45 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618244131914, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 12, 9:45 PM", has_folders: false, service_type: "upload", recent_action: "last_modified_time", display_url_name: "Screenshot+from+2021-04-09+11-30-24.png", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc" } } ], meta: { search_result_count: 0, action_id: "2774428000000002036" } }
Show fullMove File/Folder to Trash
This API trashes a file or a folder and moves it to the trash folder.
Path Parameters
resource_idstring | Mandatory The unique ID of the file/folder. |
Request Body Parameters
statusinteger | Mandatory Allowed status value:
|
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/files/{resource_id}
{ data: { attributes: { status: "51" }, type: "files" } }
Example Response
{ data: [ { id: "ly9zm3c10f18ca7e3422db10f5b335d33b0cc", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, destination_id: "ly9zme5724e019a8e4cb48632945b1296be0a", storage_info: { size: "92.0 KB", storage_used: "92.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 94427, storage_used_in_bytes: 94427 }, type: "image", created_time_i18: "Apr 12, 9:45 PM", modified_time_in_millisecond: 1618295497974, opened_time: "Apr 12, 9:45 PM", status_change_time: "Apr 13, 12:01 PM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/ly9zm3c10f18ca7e3422db10f5b335d33b0cc", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 12, 9:45 PM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "Screenshot from 2021-04-09 11-30-24.png", user_access_time: "Apr 12, 9:45 PM", created_by: "Zylker Creation", display_html_name: "Screenshot from 2021-04-09 11-30-24.png", labels: [], user_access_time_i18: "Apr 12, 9:45 PM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a", name: "Screenshot from 2021-04-09 11-30-24.png", status_change_time_in_millisecond: 1618295497974, permalink: "https://www.zohoapis.com/workdrive/file/ly9zm3c10f18ca7e3422db10f5b335d33b0cc", favorite: false, new_badge_count: 0, status: 51, modified_time_i18: "Apr 13, 12:01 PM", opened_time_i18: "Apr 12, 9:45 PM", extn: "png", user_access_time_in_millis: 1618244131914, shortcut_link: "", status_change_time_i18: "Apr 13, 12:01 PM", description: "", uploaded_time_in_millisecond: 1618244131917, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm3c10f18ca7e3422db10f5b335d33b0cc", title: "", modified_time: "Apr 13, 12:01 PM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "img", created_time_in_millisecond: 1618244131914, owner: "747937818", creator: "747938014", capabilities: { can_read: false, can_share: false, can_remove_share: false, can_delete: true, can_edit: false, can_upload_files: false, can_trash: false, can_rename: false, can_restore: true, can_copy: false, can_move: false, can_zip: false, can_download: false, can_emailattach: false, can_publish: false, can_create_task: false, can_share_support: false, can_label: true, can_checkout: false, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: false, can_create_comment: false, can_trash_files: false }, uploaded_time_i18: "Apr 12, 9:45 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618244131914, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 12, 9:45 PM", has_folders: false, service_type: "upload", recent_action: "last_modified_time", display_url_name: "Screenshot+from+2021-04-09+11-30-24.png", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc" } } ], meta: { search_result_count: 0 } }
Show fullMove Multiple Files/Folders to Trash
This API trashes multiple selected files or folders and moves them to the trash folder.
Request Body Parameters
idstring | Mandatory The unique ID of the file/folder. |
statusinteger | Mandatory Allowed status value:
|
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/files
{ data: [ { attributes: { status: "51" }, id: "ly9zm3c10f18ca7e3422db10f5b335d33b0cc", type: "files" }, { attributes: { status: "51" }, id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", type: "files" } ] }
Example Response
{ data: [ { id: "ly9zm3c10f18ca7e3422db10f5b335d33b0cc", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, destination_id: "ly9zme5724e019a8e4cb48632945b1296be0a", storage_info: { size: "92.0 KB", storage_used: "92.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 94427, storage_used_in_bytes: 94427 }, type: "image", created_time_i18: "Apr 12, 9:45 PM", modified_time_in_millisecond: 1618295186993, opened_time: "Apr 12, 9:45 PM", status_change_time: "Apr 13, 11:56 AM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/ly9zm3c10f18ca7e3422db10f5b335d33b0cc", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 12, 9:45 PM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "Screenshot from 2021-04-09 11-30-24.png", user_access_time: "Apr 12, 9:45 PM", created_by: "Zylker Creation", display_html_name: "Screenshot from 2021-04-09 11-30-24.png", labels: [], user_access_time_i18: "Apr 12, 9:45 PM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a", name: "Screenshot from 2021-04-09 11-30-24.png", status_change_time_in_millisecond: 1618295186993, permalink: "https://www.zohoapis.com/workdrive/file/ly9zm3c10f18ca7e3422db10f5b335d33b0cc", favorite: false, new_badge_count: 0, status: 51, modified_time_i18: "Apr 13, 11:56 AM", opened_time_i18: "Apr 12, 9:45 PM", extn: "png", user_access_time_in_millis: 1618244131914, shortcut_link: "", status_change_time_i18: "Apr 13, 11:56 AM", description: "", uploaded_time_in_millisecond: 1618244131917, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm3c10f18ca7e3422db10f5b335d33b0cc", title: "", modified_time: "Apr 13, 11:56 AM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "img", created_time_in_millisecond: 1618244131914, owner: "747937818", creator: "747938014", capabilities: { can_read: false, can_share: false, can_remove_share: false, can_delete: true, can_edit: false, can_upload_files: false, can_trash: false, can_rename: false, can_restore: true, can_copy: false, can_move: false, can_zip: false, can_download: false, can_emailattach: false, can_publish: false, can_create_task: false, can_share_support: false, can_label: true, can_checkout: false, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: false, can_create_comment: false, can_trash_files: false }, uploaded_time_i18: "Apr 12, 9:45 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618244131914, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 12, 9:45 PM", has_folders: false, service_type: "upload", recent_action: "last_modified_time", display_url_name: "Screenshot+from+2021-04-09+11-30-24.png", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc" } }, { id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, destination_id: "ly9zme5724e019a8e4cb48632945b1296be0a", storage_info: { size: "48.0 KB", storage_used: "48.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 50081, storage_used_in_bytes: 50081 }, type: "image", created_time_i18: "Apr 12, 9:45 PM", modified_time_in_millisecond: 1618295186993, opened_time: "Apr 12, 9:45 PM", status_change_time: "Apr 13, 11:56 AM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 12, 9:45 PM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "Screenshot from 2021-03-22 10-40-22.png", user_access_time: "Apr 12, 9:45 PM", created_by: "Zylker Creation", display_html_name: "Screenshot from 2021-03-22 10-40-22.png", labels: [], user_access_time_i18: "Apr 12, 9:45 PM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a", name: "Screenshot from 2021-03-22 10-40-22.png", status_change_time_in_millisecond: 1618295186993, permalink: "https://www.zohoapis.com/workdrive/file/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", favorite: false, new_badge_count: 0, status: 51, modified_time_i18: "Apr 13, 11:56 AM", opened_time_i18: "Apr 12, 9:45 PM", extn: "png", user_access_time_in_millis: 1618244132643, shortcut_link: "", status_change_time_i18: "Apr 13, 11:56 AM", description: "", uploaded_time_in_millisecond: 1618244132645, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", title: "", modified_time: "Apr 13, 11:56 AM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "img", created_time_in_millisecond: 1618244132643, owner: "747937818", creator: "747938014", capabilities: { can_read: false, can_share: false, can_remove_share: false, can_delete: true, can_edit: false, can_upload_files: false, can_trash: false, can_rename: false, can_restore: true, can_copy: false, can_move: false, can_zip: false, can_download: false, can_emailattach: false, can_publish: false, can_create_task: false, can_share_support: false, can_label: true, can_checkout: false, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: false, can_create_comment: false, can_trash_files: false }, uploaded_time_i18: "Apr 12, 9:45 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618244132643, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 12, 9:45 PM", has_folders: false, service_type: "upload", recent_action: "last_modified_time", display_url_name: "Screenshot+from+2021-03-22+10-40-22.png", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2" } } ], meta: { search_result_count: 0, action_id: "2774428000000002042" } }
Show fullRestore File/Folder
This API restores a file or a folder from the trash folder to its original destination.
Path Parameters
resource_idstring | Mandatory The unique ID of the file/folder. |
Request Body Parameters
statusinteger | Mandatory Allowed status value:
|
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/files/{resource_id}
{ data: { attributes: { status: "1" }, type: "files" } }
Example Response
{ data: [ { id: "ly9zm3c10f18ca7e3422db10f5b335d33b0cc", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, destination_id: "ly9zme5724e019a8e4cb48632945b1296be0a", storage_info: { size: "92.0 KB", storage_used: "92.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 94427, storage_used_in_bytes: 94427 }, type: "image", created_time_i18: "Apr 12, 9:45 PM", modified_time_in_millisecond: 1618295542045, opened_time: "Apr 12, 9:45 PM", status_change_time: "Apr 13, 12:02 PM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/ly9zm3c10f18ca7e3422db10f5b335d33b0cc", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 12, 9:45 PM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "Screenshot from 2021-04-09 11-30-24.png", user_access_time: "Apr 12, 9:45 PM", created_by: "Zylker Creation", display_html_name: "Screenshot from 2021-04-09 11-30-24.png", labels: [], user_access_time_i18: "Apr 12, 9:45 PM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a", name: "Screenshot from 2021-04-09 11-30-24.png", status_change_time_in_millisecond: 1618295542045, permalink: "https://www.zohoapis.com/workdrive/file/ly9zm3c10f18ca7e3422db10f5b335d33b0cc", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Apr 13, 12:02 PM", opened_time_i18: "Apr 12, 9:45 PM", extn: "png", user_access_time_in_millis: 1618244131914, shortcut_link: "", status_change_time_i18: "Apr 13, 12:02 PM", description: "", uploaded_time_in_millisecond: 1618244131917, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm3c10f18ca7e3422db10f5b335d33b0cc", title: "", modified_time: "Apr 13, 12:02 PM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "img", created_time_in_millisecond: 1618244131914, owner: "747937818", creator: "747938014", capabilities: { can_read: true, can_share: true, can_remove_share: false, can_delete: false, can_edit: 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: true, can_share_support: true, can_label: true, can_checkout: true, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: true, can_trash_files: true }, uploaded_time_i18: "Apr 12, 9:45 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618244131914, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 12, 9:45 PM", has_folders: false, service_type: "upload", recent_action: "last_modified_time", display_url_name: "Screenshot+from+2021-04-09+11-30-24.png", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc" } } ], meta: { search_result_count: 0 } }
Show fullRestore Multiple Files/Folders
This API restores multiple files or folders from the trash folder to their original destination.
Request Body Parameters
idstring | Mandatory The unique ID of the file/folder. |
statusinteger | Mandatory Allowed status value:
|
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/files
{ data: [ { attributes: { status: "1" }, id: "ly9zm3c10f18ca7e3422db10f5b335d33b0cc", type: "files" }, { attributes: { status: "1" }, id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", type: "files" } ] }
Example Response
{ data: [ { id: "ly9zm3c10f18ca7e3422db10f5b335d33b0cc", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, destination_id: "ly9zme5724e019a8e4cb48632945b1296be0a", storage_info: { size: "92.0 KB", storage_used: "92.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 94427, storage_used_in_bytes: 94427 }, type: "image", created_time_i18: "Apr 12, 9:45 PM", modified_time_in_millisecond: 1618295233863, opened_time: "Apr 12, 9:45 PM", status_change_time: "Apr 13, 11:57 AM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/ly9zm3c10f18ca7e3422db10f5b335d33b0cc", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 12, 9:45 PM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "Screenshot from 2021-04-09 11-30-24.png", user_access_time: "Apr 12, 9:45 PM", created_by: "Zylker Creation", display_html_name: "Screenshot from 2021-04-09 11-30-24.png", labels: [], user_access_time_i18: "Apr 12, 9:45 PM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a", name: "Screenshot from 2021-04-09 11-30-24.png", status_change_time_in_millisecond: 1618295233863, permalink: "https://www.zohoapis.com/workdrive/file/ly9zm3c10f18ca7e3422db10f5b335d33b0cc", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Apr 13, 11:57 AM", opened_time_i18: "Apr 12, 9:45 PM", extn: "png", user_access_time_in_millis: 1618244131914, shortcut_link: "", status_change_time_i18: "Apr 13, 11:57 AM", description: "", uploaded_time_in_millisecond: 1618244131917, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm3c10f18ca7e3422db10f5b335d33b0cc", title: "", modified_time: "Apr 13, 11:57 AM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "img", created_time_in_millisecond: 1618244131914, owner: "747937818", creator: "747938014", capabilities: { can_read: true, can_share: true, can_remove_share: false, can_delete: false, can_edit: 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: true, can_share_support: true, can_label: true, can_checkout: true, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: true, can_trash_files: true }, uploaded_time_i18: "Apr 12, 9:45 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618244131914, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 12, 9:45 PM", has_folders: false, service_type: "upload", recent_action: "last_modified_time", display_url_name: "Screenshot+from+2021-04-09+11-30-24.png", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc" } }, { id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, destination_id: "ly9zme5724e019a8e4cb48632945b1296be0a", storage_info: { size: "48.0 KB", storage_used: "48.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 50081, storage_used_in_bytes: 50081 }, type: "image", created_time_i18: "Apr 12, 9:45 PM", modified_time_in_millisecond: 1618295233863, opened_time: "Apr 12, 9:45 PM", status_change_time: "Apr 13, 11:57 AM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 12, 9:45 PM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "Screenshot from 2021-03-22 10-40-22.png", user_access_time: "Apr 12, 9:45 PM", created_by: "Zylker Creation", display_html_name: "Screenshot from 2021-03-22 10-40-22.png", labels: [], user_access_time_i18: "Apr 12, 9:45 PM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a", name: "Screenshot from 2021-03-22 10-40-22.png", status_change_time_in_millisecond: 1618295233863, permalink: "https://www.zohoapis.com/workdrive/file/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Apr 13, 11:57 AM", opened_time_i18: "Apr 12, 9:45 PM", extn: "png", user_access_time_in_millis: 1618244132643, shortcut_link: "", status_change_time_i18: "Apr 13, 11:57 AM", description: "", uploaded_time_in_millisecond: 1618244132645, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", title: "", modified_time: "Apr 13, 11:57 AM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "img", created_time_in_millisecond: 1618244132643, owner: "747937818", creator: "747938014", capabilities: { can_read: true, can_share: true, can_remove_share: false, can_delete: false, can_edit: 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: true, can_share_support: true, can_label: true, can_checkout: true, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: true, can_trash_files: true }, uploaded_time_i18: "Apr 12, 9:45 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618244132643, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 12, 9:45 PM", has_folders: false, service_type: "upload", recent_action: "last_modified_time", display_url_name: "Screenshot+from+2021-03-22+10-40-22.png", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2" } } ], meta: { search_result_count: 0, action_id: "2774428000000002044" } }
Show fullPermanent Delete File/Folder
This API permanently deletes a file or a folder from the trash folder.
Path Parameters
resource_idstring | Mandatory The unique ID of the file/folder. |
Request Body Parameters
statusinteger | Mandatory Allowed status value:
|
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/files/{resource_id}
{ data: { attributes: { status: "61" }, type: "files" } }
Example Response
{ data: [ { id: "ly9zm3c10f18ca7e3422db10f5b335d33b0cc", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, destination_id: "ly9zme5724e019a8e4cb48632945b1296be0a", storage_info: { size: "92.0 KB", storage_used: "92.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 94427, storage_used_in_bytes: 94427 }, type: "image", created_time_i18: "Apr 12, 9:45 PM", modified_time_in_millisecond: 1618295803610, opened_time: "Apr 12, 9:45 PM", status_change_time: "Apr 13, 12:06 PM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/ly9zm3c10f18ca7e3422db10f5b335d33b0cc", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 12, 9:45 PM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "Screenshot from 2021-04-09 11-30-24.png", user_access_time: "Apr 12, 9:45 PM", created_by: "Zylker Creation", display_html_name: "Screenshot from 2021-04-09 11-30-24.png", labels: [], user_access_time_i18: "Apr 12, 9:45 PM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a", name: "Screenshot from 2021-04-09 11-30-24.png", status_change_time_in_millisecond: 1618295803610, permalink: "https://www.zohoapis.com/workdrive/file/ly9zm3c10f18ca7e3422db10f5b335d33b0cc", favorite: false, new_badge_count: 0, status: 61, modified_time_i18: "Apr 13, 12:06 PM", opened_time_i18: "Apr 12, 9:45 PM", extn: "png", user_access_time_in_millis: 1618244131914, shortcut_link: "", status_change_time_i18: "Apr 13, 12:06 PM", description: "", uploaded_time_in_millisecond: 1618244131917, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm3c10f18ca7e3422db10f5b335d33b0cc", title: "", modified_time: "Apr 13, 12:06 PM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "img", created_time_in_millisecond: 1618244131914, owner: "747937818", creator: "747938014", capabilities: { can_read: false, can_share: false, can_remove_share: false, can_delete: false, can_edit: false, can_upload_files: false, can_trash: false, can_rename: false, can_restore: false, can_copy: false, can_move: false, can_zip: false, can_download: false, can_emailattach: false, can_publish: false, can_create_task: false, can_share_support: false, can_label: true, can_checkout: false, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: false, can_create_comment: false, can_trash_files: false }, uploaded_time_i18: "Apr 12, 9:45 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618244131914, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 12, 9:45 PM", has_folders: false, service_type: "upload", recent_action: "last_modified_time", display_url_name: "Screenshot+from+2021-04-09+11-30-24.png", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm3c10f18ca7e3422db10f5b335d33b0cc" } } ], meta: { search_result_count: 0 } }
Show fullPermanent Delete Multiple Files/Folders
This API permanently deletes a set of files from the trash folder.
Request Body Parameters
idstring | Mandatory The unique ID of the file/folder. |
statusinteger | Mandatory Allowed status value:
|
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/files
{ data: [ { attributes: { status: "61" }, id: "ly9zm4ab06bc0994343c6a24f7b11e3111037", type: "files" }, { attributes: { status: "61" }, id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", type: "files" } ] }
Example Response
{ data: [ { id: "ly9zm4ab06bc0994343c6a24f7b11e3111037", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, destination_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", storage_info: { size: "90.0 KB", storage_used: "90.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 92684, storage_used_in_bytes: 92684 }, type: "image", created_time_i18: "Apr 13, 12:00 AM", modified_time_in_millisecond: 1618295972512, opened_time: "Apr 13, 12:00 AM", status_change_time: "Apr 13, 12:09 PM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/ly9zm4ab06bc0994343c6a24f7b11e3111037", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 13, 12:00 AM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "Capture.JPG", created_by: "Zylker Creation", display_html_name: "Capture.JPG", labels: [], org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", name: "Capture.JPG", status_change_time_in_millisecond: 1618295972512, permalink: "https://www.zohoapis.com/workdrive/file/ly9zm4ab06bc0994343c6a24f7b11e3111037", favorite: false, new_badge_count: 0, status: 61, modified_time_i18: "Apr 13, 12:09 PM", opened_time_i18: "Apr 13, 12:00 AM", extn: "jpg", shortcut_link: "", status_change_time_i18: "Apr 13, 12:09 PM", description: "", uploaded_time_in_millisecond: 1618252229303, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm4ab06bc0994343c6a24f7b11e3111037", title: "", modified_time: "Apr 13, 12:09 PM", library_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", icon_class: "img", created_time_in_millisecond: 1618252229301, owner: "747937818", creator: "747938058", capabilities: { can_read: false, can_share: false, can_remove_share: false, can_delete: false, can_edit: false, can_upload_files: false, can_trash: false, can_rename: false, can_restore: false, can_copy: false, can_move: false, can_zip: false, can_download: false, can_emailattach: false, can_publish: false, can_create_task: false, can_share_support: false, can_label: true, can_checkout: false, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: false, can_create_comment: false, can_trash_files: false }, uploaded_time_i18: "Apr 13, 12:00 AM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618252229301, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 13, 12:00 AM", has_folders: false, service_type: "upload", display_url_name: "Capture.JPG", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm4ab06bc0994343c6a24f7b11e3111037" } }, { id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, collab_id: "2243193151340634610", destination_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", storage_info: { size: "48.0 KB", storage_used: "48.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 50081, storage_used_in_bytes: 50081 }, type: "image", created_time_i18: "Apr 12, 9:45 PM", modified_time_in_millisecond: 1618295972512, opened_time: "Apr 12, 9:45 PM", status_change_time: "Apr 13, 12:09 PM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 12, 9:45 PM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "User screenshot.png", user_access_time: "Apr 13, 11:58 AM", created_by: "Zylker Creation", display_html_name: "User screenshot.png", labels: [], user_access_time_i18: "Apr 13, 11:58 AM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", name: "User screenshot.png", status_change_time_in_millisecond: 1618295972512, permalink: "https://www.zohoapis.com/workdrive/file/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", favorite: false, new_badge_count: 0, status: 61, modified_time_i18: "Apr 13, 12:09 PM", opened_time_i18: "Apr 12, 9:45 PM", extn: "png", user_access_time_in_millis: 1618295295764, shortcut_link: "", status_change_time_i18: "Apr 13, 12:09 PM", description: "", uploaded_time_in_millisecond: 1618244132645, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", title: "", modified_time: "Apr 13, 12:09 PM", library_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", icon_class: "img", created_time_in_millisecond: 1618244132643, owner: "747937818", creator: "747938014", capabilities: { can_read: false, can_share: false, can_remove_share: false, can_delete: false, can_edit: false, can_upload_files: false, can_trash: false, can_rename: false, can_restore: false, can_copy: false, can_move: false, can_zip: false, can_download: false, can_emailattach: false, can_publish: false, can_create_task: false, can_share_support: false, can_label: true, can_checkout: false, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: false, can_create_comment: false, can_trash_files: false }, uploaded_time_i18: "Apr 12, 9:45 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618244132643, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 12, 9:45 PM", has_folders: false, service_type: "upload", recent_action: "last_modified_time", display_url_name: "User+screenshot.png", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2" } } ], meta: { search_result_count: 0, action_id: "2774428000000002050" } }
Show fullGet list of associated Data Templates
This API fetches all data templates associated with a specific file or folder.
Path Parameters
resource_idstring | Mandatory The unique ID of the file or folder. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/files/{resource_id}/custommetadata
Example Response
{ data: [ { id: "nrkrod816f237389b4c05a65fc15b4a4dacc3-24000000581001", type: "custommetadata", attributes: { data_template_id: "nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001", name: "Recruitment - 2021", description: "Associate files and folders of all candidates registered for recruitment in 2021", resource_id: "nrkrod816f237389b4c05a65fc15b4a4dacc3", custom_data: [ { custom_field_id: "nrkrod816f237389b4c05a65fc15b4a4dacc3-MjQwMDAwMDA1ODEwMDEtMjQwMDAwMDA1ODIwMDE", display_name: "Candidate Name", type: "text", column_name: "CF60", field_properties: { description: "Name of the candidate", is_mandatory: true, default_value: "", max_char_length: "50" }, value: "Peter", index: 0 }, { custom_field_id: "nrkrod816f237389b4c05a65fc15b4a4dacc3-MjQwMDAwMDA1ODEwMDEtMjQwMDAwMDA1ODIwMDI", display_name: "Candidate Role", type: "dropdown", column_name: "CF61", field_properties: { description: "Role of the candidate", is_mandatory: false, default_value: "" }, value: "Developer", index: 1, choices: [ { key: "Developer" }, { key: "Designer" }, { key: "Marketer" } ] } ], is_associated_without_cf: false, status: true }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/custommetadata/nrkrod816f237389b4c05a65fc15b4a4dacc3-24000000581001" } } ] }
Show fullFolders
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.
List Files/Folders inside a Folder
This API lists down all the files and folders present within a folder.
Path Parameters
folder_idstring | Mandatory 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 |
filter[externalUpload]string | Optional Set 'false' to avoid externally uploaded folders. |
filter[extension]string | Optional Filter resources by their file extensions.
|
page[limit]string | Optional Limit indicates the number of items to be listed. 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. |
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. |
fields[files]string | Optional Mention the required params to be included in the response attribute. |
sortstring | Optional Sorting can be done with these fields:
|
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/files/{folder_id}/files?page%5Blimit%5D=50&page%5Boffset%5D=0
Example Response
{ 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" } } }
Show fullCreate Folder
This API creates a folder in WorkDrive.
Request Body Parameters
namestring | Mandatory The name of the new folder to be created. |
parent_idstring | Mandatory The unique ID of the destination folder/team folder.
|
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/files
{ data: { attributes: { name: "Collection", parent_id: "0nk78318a1771da934f22939e4a00d8aab225" }, type: "files" } }
Example Response
{ data: { id: "cjrrr11cfe79441684ada83b862c32f3696a9", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 0, is_fillable_resource: false, is_published: false, destination_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", 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, 12:29 PM", modified_time_in_millisecond: 1618297152723, opened_time: "Apr 13, 12:29 PM", status_change_time: "Apr 13, 12:29 PM", download_url: "https://www.zohoapis.com/workdrive/download/cjrrr11cfe79441684ada83b862c32f3696a9", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 13, 12:29 PM", lock_status: 2, is_folder: true, resource_type: 1001, is_email_in_upload: false, display_attr_name: "Collection", created_by: "Zylker Creation", display_html_name: "Collection", labels: [], org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", name: "Collection", status_change_time_in_millisecond: 1618297152723, permalink: "https://www.zohoapis.com/workdrive/folder/cjrrr11cfe79441684ada83b862c32f3696a9", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Apr 13, 12:29 PM", opened_time_i18: "Apr 13, 12:29 PM", extn: "", view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, shortcut_link: "", status_change_time_i18: "Apr 13, 12:29 PM", description: "", uploaded_time_in_millisecond: 1618297152725, thumbnail_url: "", title: "", files_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, modified_time: "Apr 13, 12:29 PM", library_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", icon_class: "folder", created_time_in_millisecond: 1618297152723, 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, 12:29 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618297152723, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 13, 12:29 PM", has_folders: false, service_type: "upload", display_url_name: "Collection", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/relationships/files", related: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/relationships/links", related: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr11cfe79441684ada83b862c32f3696a9" } } }
Show fullFile Version
WorkDrive allows users to manage a series of document versions and switch back to any previous version of a file without overwriting the current version.
- For private team folders, a member must have the Editor role or higher to view the versions of a file.
- For public team folders, any team folder member can view the versions of a file.
- For shared files, any shared user can view their versions.
Upload New Version
This API uploads a new version of a file.
- This API will only upload files of size up to 250MB. To upload files more than 250MB, use Upload Large File API.
- We recommend using Chunk File Upload API for files greater than 1 GB in size.
- We have code samples for this API in multiple programming languages.See code samples
- Only admins, organizers, and editors can upload files in a team folder.
Request Body Parameters
filenamestring | Mandatory The name of the file should be URL encoded with UTF-8 Charset. |
parent_idstring | Mandatory The unique ID of the folder to be uploaded. |
override-name-existstring | Mandatory Set "true" to upload the file as a new version. |
contentfile | Mandatory Multi-part file to be uploaded, and the maximum file size is 250 MB. |
Based on the status code in response, you can monitor the upload status of files.
Upload Status codes:
- 200 - Returns File Meta in response.
- 400 - Content parameter is missing.
- 401 - Invalid user's credentials/ Parent folder not belong to the user.
- 402 - WorkDrive license is in a suspended state.
- 409 - Same file name already in this Parent folder. File will not be uploaded.
- 413 - File size is greater than 250 MB.
- 500 - An Unknown error occurred
- 507 - User organization storage is full.
- 509 - User's MyFolders storage is full.
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/upload
Example Response
{ data: [ { attributes: { Permalink: "https://www.zohoapis.com/workdrive/file/cjrrr55b395f872ad4b0a8c52b02eab98c1c5", "File INFO": "{"OWNER":"747937818","RESOURCE_GROUP":"FILE","OPERATION":"UPDATE","RESOURCE_ID":"cjrrr55b395f872ad4b0a8c52b02eab98c1c5","LIBRARY_ID":"ly9zme5724e019a8e4cb48632945b1296be0a","EVENT_ID":"-1","AUDIT_INFO":{"versionInfo":{"versionAuthors":["Zylker Creation"],"versionId":"2774428000000002076","isMinorVersion":false,"versionTime":"1618306596243","versionAuthorZuid":["747938014"],"versionNotes":"Updated through upload action","versionNumber":"4.0"},"parentInfo":{"parentName":"Notes","parentId":"cjrrr81bad43595d94a5bbbb4ea1589ef9236","parentType":1001},"libraryInfo":{"libraryName":"MYSPACE_LIBRARY","libraryId":"ly9zme5724e019a8e4cb48632945b1296be0a","libraryType":20},"resourceInfo":{"service_type":4,"extension":"jpg","resource_type":2501,"name":"Capture.JPG","resource_id":"cjrrr55b395f872ad4b0a8c52b02eab98c1c5"},"updateType":"UPDATE_TYPE_REV_UPLOAD_FOR_SAMENAME","statusCode":"D201"},"ZUID":747938014,"PARENT_ID":"cjrrr81bad43595d94a5bbbb4ea1589ef9236","TEAM_ID":"ly9zmae16b43c258f458a9a57ac02c4f8d763","RESOURCE_TYPE":2501,"WMS_SENT_TIME":"1618306596311"}", parent_id: "cjrrr81bad43595d94a5bbbb4ea1589ef9236", FileName: "Capture.JPG", resource_id: "cjrrr55b395f872ad4b0a8c52b02eab98c1c5" }, type: "files" } ] }
Show fullDownload File Version
This API returns the file content of the specified version in binary format. We are supporting a common API to download all file types.
The various domains and their respective download server domain URLs are:
- US: https://download.zoho.com
- AU: https://download.zoho.com.au
- EU: https://download.zoho.eu
- IN: https://download.zoho.in
- CN: https://download.zoho.com.cn
Path Parameters
resource_idstring |
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
versionstring |
Example Request
GET https://download.zoho.com/v1/workdrive/download/{resource_id}?version=file_version_number
Restore as Top Version
This API restores a specific version of a file to be the top version of the file.
Request Body Parameters
resource_idstring | Mandatory The unique ID of the file. |
revert_tostring | Mandatory The version of the file that needs to be set as the top version. |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/versions
{ data: { attributes: { resource_id: "cjrrr55b395f872ad4b0a8c52b02eab98c1c5", revert_to: "5.0" }, type: "versions" } }
Example Response
{ data: { id: "cjrrr55b395f872ad4b0a8c52b02eab98c1c5-2774428000000002078", type: "versions", attributes: { created_time: "Apr 13, 3:07 PM", is_locked: false, notes: "Reverted to version 3.0", capabilities: { can_read: true, can_edit: true, can_delete: true }, del_time: -1, created_time_in_milliseconds: 1618306634449, version_number: 5, version_id: 2774428000000002000, created_by: "Zylker Creation", file_size: 92684, file_id: 2774428000000002000, size_in_bytes: "90.0 KB", resource_id: "cjrrr55b395f872ad4b0a8c52b02eab98c1c5" }, links: { self: "https://www.zohoapis.com/workdrive/versions/cjrrr55b395f872ad4b0a8c52b02eab98c1c5-2774428000000002078" } } }
Show fullDelete Version
This API deletes a specific version of a file. Version id is created when a user creates a new version of the file.
Path Parameters
version_idstring | Mandatory The value of the version to be deleted. |
Example Request
DELETE https://www.zohoapis.com/workdrive/api/v1/versions/{version_id}
Example Response
204: No Content
Chunk Upload
Chunk File Upload API allows you to upload large files (size > 1 GB and up to 250 GB) efficiently where you can pause and resume uploads, and prevent failures even in a less stable network. Since the upload resumes from the point where it has been interrupted (instead from the beginning), you can save your internet data consumption.
The upload limit depends on the WorkDrive plan. Compare WorkDrive plans here.
For chunk upload, a new upload session will be created for every file. We have provided three APIs to upload the chunk files. They are: Create, Upload, and Commit Sessions.
Note:
Chunk file upload will be available only for files greater than 1 GB. For files less than 1 GB in size, normal full-file upload process will be followed.
General Terminology:
User should create a session for each file upload with the below API. Storage and file size limit of the team, user's upload permission, and file name validation will be performed. Once the request is authorised, we will send a response with Chunk details as follows:- chunk_size: Multiple of 64 MB in bytes for files above 1 GB, and multiple of 128 MB in bytes for files above 10 GB. All chunks except the last chunk should be uploaded with the given chunk size
- upload_id: Unique ID of the upload session. This should be used for further API calls throughout the session.
- chunks_uploaded: Chunks uploaded so far.
- remaining_chunks: Chunks yet to be uploaded.
- bytes_received: Total file size received in bytes.
- remaining_bytes: Remaining file size yet to be uploaded in bytes.
- expiry_time: Expiry time in ISO format (usually 7 days). We will not allow any action for the session after the expired time.
- total_chunks: Total chunk count of the file.
- file_size: Size of the file.
- next_chunk: Next byte range to be uploaded. We have followed the sequential chunk order. So, if a user tries to upload any other range (other than the mentioned range), we will not allow users to upload the chunk file.
- status: Current status of the chunk upload.
Create Session (Normal Upload)
This API is used to upload a new file to your WorkDrive account.
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
sizestring | Mandatory Size of the file in bytes |
file_namestring | Mandatory Name of the uploading file |
parent_idstring | Mandatory Parent folder ID in which file will be uploaded. |
name_conflictstring | Optional If the same name exists (Default option is fail)
|
Upload Status codes:
- 200 - Session created successfully.
- 401 - Create session failed.Given resource-id is not a valid parent or Chunk Upload is not allowed for this file size.
- 402 - Create session failed. License is in suspended state.
- 404 - Create session failed. File size limit exceeds.
- 409 - Create session failed. File with the same name already exists. Use name-conflict parameter to create a new file name or update the existing file.
- 423 - Create session failed.File has been checked out (locked) by another user.
- 507 - Create session failed. Your workdrive organization storage limit exceeds.
- 509 - Create session failed. MyFolder storage limit is restricted or exceeded.
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/uploadsession/create?size={size_of_the_file}&file_name={name_of_the_file}&parent_id={parent_id}&name_conflict=fail
Example Response
{ received_bytes: 0, chunk_size: 67108864, upload_id: "CFU_NjY3MDA5NjIxXzc5OTEzMjIxMl81NzE5ODk5MDA1MDY4NzM3ODkx", remaining_chunks: 18, expiry_time_in_millis: 1682600933654, total_chunks: 18, file_size: 1141420772, next_chunk: "0-67108863", remaining_bytes: 1141420772, expiry_time: "2023-04-27T13:08:53.654Z", uploaded_chunks: 0, status: "D9231" }
Create Session for Revision Upload
This API is used to upload a file as the top version to an existing file in your WorkDrive account.
- resource_id in the URL should be existing file resource_id.
Path Parameters
resource_idstring | Mandatory Unique id of the resource |
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
sizestring | Mandatory Size of the file in bytes |
Upload Status codes:
- 200 - Session created successfully.
- 401 - Create session failed.Given resource-id is not a valid file or Chunk Upload is not allowed for this file size.
- 402 - Create session failed. License is in suspended state.
- 404 - Create session failed. File size limit exceeds.
- 409 - Create session failed. File with the same name already exists. Use name-conflict parameter to create a new file name or update the existing file.
- 423 - Create session failed. File has been checked out (locked) by another user.
- 507 - Create session failed. Your workdrive organization storage limit exceeds.
- 509 - Create session failed. MyFolder storage limit is restricted or exceeded.
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/uploadsession/{resource_id}/create?size={size_of_the_file}
Example Response
{ received_bytes: 0, chunk_size: 67108864, upload_id: "CFU_NjY3MDA5NjIxXzc5OTEzMjIxMl81NzE5ODk5MDA1MDY4Nzg5MDky", remaining_chunks: 18, expiry_time_in_millis: 1682601016312, total_chunks: 18, file_size: 1141420772, next_chunk: "0-67108863", remaining_bytes: 1141420772, expiry_time: "2023-04-27T13:10:16.312Z", uploaded_chunks: 0, status: "D9231" }
Large File Upload as Chunks
Once the upload session is created, a user can upload the chunks in a sequential order. Upload API is common for both normal upload and revision upload. In each upload call, we will validate the following things.
- Upload session should be created for the given upload-id.
- Content length should be equal to the chunk size.
- Content range should be equal to the next-chunk value.
- Session should be active. It will be validated with expiry time.
- Once a chunk is uploaded, we will send a response with status and the next chunk's details similar to the Create Session API response, or user can use the Chunk Upload Session Progress (GET Method) API to get the chunk details.
- We have to send several chunks one by one as binary.
Header Parameters
upload-idstring | Mandatory Upload ID from the Create Session API. |
Content-Rangestring | Mandatory Uploading chunk byte range.
|
x-streammodestring | Mandatory Upload content transfer mode type.
|
Content-Lengthstring | Mandatory The Content-Length header indicates the size of the message body, in bytes, sent to the recipient.
|
Status codes:
- 200 - Chunk upload request completed successfully.
- 400 - Upload failed. Upload session has expired.
- 401 - Upload failed. Invalid OAuth token/scope or no permission to upload.
- 412 - Upload failed. Upload session has already been completed.
Additional error codes:
- D9232 - Upload failed. Invalid upload ID.
- D9233 - Upload failed. Invalid byte range or chunk order.
- D9234 - Upload failed. Upload session has expired.
Example Request
POST https://upload.zoho.com/workdrive-api/v1/stream/upload
Example Response
{ received_bytes: 67108864, chunk_size: 67108864, upload_id: "CFU_NjY3MDA5NjIxXzc5OTEzMjIxMl81NzE5ODk5MDA1MDY4NzM3ODkx", remaining_chunks: 17, expiry_time_in_millis: 1682601204850, md5_checksum: "5f6e72c188b2e0e1f19aa16082a786cd", total_chunks: 18, file_size: 1141420772, next_chunk: "67108864-134217727", remaining_bytes: 1074311908, expiry_time: "2023-04-27T13:13:24.850Z", uploaded_chunks: 1, status: "D9231" }
Commit Session (Normal Upload)
Once all chunks are uploaded, user can use the commit API to complete the session and create/update the file. In the commit session API, storage and file size limit of the team, upload permission of the user, and file name validation will be performed.
All chunks should be uploaded before invoking the commit API. Session should be active, and it will be validated with expiry time. If the request is authorized, we will create/update a file and send a response with file's meta data.
During normal upload, after uploading all chunks, in order to finish uploading the chunks and complete the created session, this API is called.
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
upload_idstring | Mandatory Upload ID from the Create Session API. |
parent_idstring | Mandatory Parent folder ID in which the file will be uploaded. |
file_namestring | Optional Name of the uploading file |
name_conflictstring | Optional If the same name exists (Default option is fail) |
Error codes:
- 200 - Commit session completed successfully.
- 400 - Commit session failed. Given upload-id is expired or upload session has expired.
- 401 - Commit session failed.Given resource-id and upload session resource-id are not the same.
- 404 - Commit session failed. Invalid Upload ID
- 412 - Commit session failed. Upload session has already been completed or chunks are yet to be uploaded.
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/uploadsession/commit?upload_id={upload_id}&parent_id={parent_id}&file_name={name_of_the_file}&name_conflict=fail
Example Response
{ data: [ { attributes: { Permalink: "https://www.zohoapis.com/workdrive/file/3smnqc10ed7e4525342d4bb396d5ff795e549", "File INFO": { ORG_ID: "6oq3d00e1e07d58c64077b4f1c1f28da4a777", RESOURCE_ID: "3smnqc10ed7e4525342d4bb396d5ff795e549", LIBRARY_ID: "5txno9b6ca82a4dd84f90b9bea038273d33e3", PARENT_MODEL_ID: "s7llp4b105a761a10474695c5031562f2c1d1", PARENT_ID: "s7llp4b105a761a10474695c5031562f2c1d1", RESOURCE_TYPE: 2506, WMS_SENT_TIME: "1681998140999", TAB_ID: "-1", OWNER: "667009621", RESOURCE_GROUP: "FILE", PARENT_MODEL_NAME: "file", size: 1141420772, OPERATION: "UPLOAD", EVENT_ID: "-1", AUDIT_INFO: { uploadId: "CFU_NjY3MDA5NjIxXzc5OTEzMjIxMl81NzE5ODk5MDA1MDY4OTk5MDIz", resource: { owner: "667009621", created_time: 1681998140949, creator: "799132212", service_type: 4, extension: "zip", resource_type: 2506, name: "aa.zip" }, parentInfo: { parentName: "Testing", parentId: "s7llp4b105a761a10474695c5031562f2c1d1", parentType: 1001 }, libraryInfo: { libraryName: "MYSPACE_LIBRARY", libraryId: "5txno9b6ca82a4dd84f90b9bea038273d33e3", libraryType: 20 }, statusCode: "D201" }, ZUID: 799132212, TEAM_ID: "6oq3d00e1e07d58c64077b4f1c1f28da4a777" }, parent_id: "s7llp4b105a761a10474695c5031562f2c1d1", FileName: "aa.zip", resource_id: "3smnqc10ed7e4525342d4bb396d5ff795e549" }, type: "files" } ] }
Show fullCommit Session for Revision Upload
During revision upload, after uploading a new version of an already existing file, in order to finish uploading the chunks and complete the created session, this API is called.
- resource_id in the URL should be existing file's resource_id.
Path Parameters
resource_idstring | Mandatory Unique id of the resource. |
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
upload_idstring | Mandatory Upload ID from Create session API. |
Status codes:
- 200 - Commit session completed successfully.
- 400 - Commit session failed. Given upload-id is expired or upload session has expired.
- 401 - Commit session failed.Given parent-id and upload session parent-id are not the same.
- 404 - Commit session failed. Invalid Upload ID.
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/uploadsession/{resource_id}/commit?upload_id={upload_id}
Example Response
{ data: [ { attributes: { Permalink: "https://www.zohoapis.com/workdrive/file/3smnqc10ed7e4525342d4bb396d5ff795e549", "File INFO": { ORG_ID: "6oq3d00e1e07d58c64077b4f1c1f28da4a777", RESOURCE_ID: "3smnqc10ed7e4525342d4bb396d5ff795e549", LIBRARY_ID: "5txno9b6ca82a4dd84f90b9bea038273d33e3", PARENT_MODEL_ID: "s7llp4b105a761a10474695c5031562f2c1d1", PARENT_ID: "s7llp4b105a761a10474695c5031562f2c1d1", RESOURCE_TYPE: 2506, WMS_SENT_TIME: "1681999077624", TAB_ID: "-1", OWNER: "667009621", RESOURCE_GROUP: "FILE", PARENT_MODEL_NAME: "file", size: 1141420772, OPERATION: "UPDATE", EVENT_ID: "-1", AUDIT_INFO: { uploadId: "CFU_NjY3MDA5NjIxXzc5OTEzMjIxMl81NzE5ODk5MDA1MDY5MDg4Njgx", versionInfo: { versionAuthors: [ "Avinash R" ], versionId: "5719899005069152734", isMinorVersion: false, versionTime: "1681999077577", versionAuthorZuid: [ "799132212" ], versionNotes: "", versionNumber: "2.0" }, parentInfo: { parentName: "Testing", parentId: "s7llp4b105a761a10474695c5031562f2c1d1", parentType: 1001 }, libraryInfo: { libraryName: "MYSPACE_LIBRARY", libraryId: "5txno9b6ca82a4dd84f90b9bea038273d33e3", libraryType: 20 }, resourceInfo: { service_type: 4, extension: "zip", resource_type: 2506, name: "aa.zip", resource_id: "3smnqc10ed7e4525342d4bb396d5ff795e549" }, updateType: "UPDATE_TYPE_REV_UPLOAD", statusCode: "D201" }, ZUID: 799132212, TEAM_ID: "6oq3d00e1e07d58c64077b4f1c1f28da4a777" }, parent_id: "s7llp4b105a761a10474695c5031562f2c1d1", FileName: "aa.zip", resource_id: "3smnqc10ed7e4525342d4bb396d5ff795e549" }, type: "files" } ] }
Show fullUpload Session Progress
A user can use this API to get the status of the chunk upload session.
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
upload_idstring | Mandatory Upload ID from the Create Session API. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/uploadsession?upload_id={Upload_ID_from_the_Create_Session_API}
Example Response
{ received_bytes: 67108864, chunk_size: 67108864, upload_id: "CFU_NjY3MDA5NjIxXzc5OTEzMjIxMl81NzE5ODk5MDA1MDY4NzM3ODkx", remaining_chunks: 17, expiry_time_in_millis: 1682601204850, md5_checksum: "5f6e72c188b2e0e1f19aa16082a786cd", total_chunks: 18, file_size: 1141420772, next_chunk: "67108864-134217727", remaining_bytes: 1074311908, expiry_time: "2023-04-27T13:13:24.850Z", uploaded_chunks: 1, status: "D9231" }
Get Recent Changes
This API section is used to check for any changes in the data stored in WorkDrive, and sync or back them up based on the set time.
Get Start Token
This API is used to generate the starting point token, which is required to check the changes in the WorkDrive account. You can choose the time from the current time to up to the last 31 days.
Note:
Your date will be converted to our server's time zone.
Path Parameters
resource_idstring | Mandatory The unique ID of My Folders, Team Folder, or any sub folder. |
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
page[token]string | Mandatory Set the token value in one of the below methods:
|
page[limit]string | Optional Page limit refers to the total page results you need to view using the API response. A single page contains 50 results (files and/or folders).
Note: Maximum pages you can set is 1000. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/changes/{resource_id}?page%5Btoken%5D={token}
Example Response
{ data: { id: "ipcpn30c4b2a548bc4986bfc4502e040f2fa9", type: "changes", attributes: { expires_in: 2678400, token: "https://www.zohoapis.com/workdrive/api/v1/changes?page[next]=7e27d02e04a9b6a7565dcc90e099fadd258a108eb4b3b0c2cb05343413b5099497c89138ee437a07565bfc978a3660d9b" }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/changes/ipcpn30c4b2a548bc4986bfc4502e040f2fa9" } } }
Get list of Recent Changes
This API provides a list of all files and folders that were modified or added during the given time. The start page token should be used within the expiration period mentioned in the previous API response (expires_in).
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
page[next]string | Mandatory Use the page token received from the above API. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/changes?page%5Bnext%5D={token}
Example Response
{ data: [ { id: "ipcpn2210d2d6410e4b5b963bee32450afa88", type: "changes", attributes: { action_category: "CREATE", action_type: 102, resource_type: 1001, change_by_zuid: "15068447", change_time_in_mills: 1684399037120, event_id: 27000000018006, resource_group: "FOLDER", is_deleted: false, library_id: "ipcpneffc5b2f509b44029d7303399163cea2", parent_id: "ipcpneffc5b2f509b44029d7303399163cea2", action: "CREATE", change_by: "Sofia Deluca", resource_name: "Marketing", change_time: "May 18, 2:07 PM" }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/changes/ipcpn2210d2d6410e4b5b963bee32450afa88" } }, { id: "ipcpn8733e8ba9fd5468ba663cd681b25636f", type: "changes", attributes: { action_category: "UPDATE", action_type: 105, resource_type: 2102, change_by_zuid: "15068447", change_time_in_mills: 1684399112830, event_id: 27000000018015, resource_group: "FILE", is_deleted: false, library_id: "ipcpneffc5b2f509b44029d7303399163cea2", parent_id: "ipcpneffc5b2f509b44029d7303399163cea2", action: "RENAME", change_by: "Sofia Deluca", resource_name: "Stocks 2022 to 2023 Financial Year.csv", change_time: "May 18, 2:08 PM" }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/changes/ipcpn8733e8ba9fd5468ba663cd681b25636f" } }, { id: "ipcpn84ff19b4fe5341fc9b95074fa6b94b4a", type: "changes", attributes: { action_category: "MOVE", action_type: 106, resource_type: 2002, change_by_zuid: "15068447", change_time_in_mills: 1684399238761, event_id: 27000000018044, resource_group: "FILE", is_deleted: false, library_id: "ipcpneffc5b2f509b44029d7303399163cea2", parent_id: "ipcpneffc5b2f509b44029d7303399163cea2", move_info: { move_from: "ipcpnfeb0a411d2aa4023aa323dd845725970", move_to: "ipcpneffc5b2f509b44029d7303399163cea2" }, action: "MOVE", change_by: "Sofia Deluca", resource_name: "Marketing Budget 2023 Q2.docx", change_time: "May 18, 2:10 PM" }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/changes/ipcpn84ff19b4fe5341fc9b95074fa6b94b4a" } }, { id: "ipcpnccd23f5eb0114940b1dec46b2b395c8b", type: "changes", attributes: { action_category: "DELETE", action_type: 111, resource_type: 2505, change_by_zuid: "15068447", change_time_in_mills: 1684399497031, event_id: 27000000018047, resource_group: "FILE", is_deleted: true, library_id: "ipcpneffc5b2f509b44029d7303399163cea2", parent_id: "ipcpnfeb0a411d2aa4023aa323dd845725970", action: "TRASH", change_by: "Sofia Deluca", resource_name: "Magazine Ad 02.pdf", change_time: "May 18, 2:14 PM" }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/changes/ipcpnccd23f5eb0114940b1dec46b2b395c8b" } } ], links: { cursor: { has_next: true, next: "https://www.zohoapis.com/workdrive/api/v1/changes?page[next]=e80e611e97e54e19d3374f7e2f51a9c1aae4eeaf2f281750" } } }
Show fullFile/Folder Sharing
WorkDrive allows its users to share files both internally and externally for multiple use cases.
By default, all files and folders within a team folder are shared to all its members. This avoids the necessity to share files and folders with individuals again.
Note:
Only the Admins and Organizers of a team folder can share its files and folders with other team members and external users.
Get File/Folder Collaboration Info
This API returns sharing information about the file or folder. The permission_id is created when the file or folder is shared with other team members.
This will retrieve the date, time, sender, receiver, and the file access role provided during the file/folder sharing.
Path Parameters
permission_idstring | Mandatory The unique ID that represents collaboration. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/permissions/{permission_id}
Example Response
{ data: { id: "jxtee81865c6d7ed64dc596540aa30dfd2753-747938058", type: "permissions", attributes: { email_id: "reyansh.ahuja@zylker.com", shared_time_in_millis: 1618401188121, shared_by: "Zylker Creation", expiry_in_millis: 0, relation_type: 0, expiration_date: "Jan 1, 1970, 5:30 AM", share_to_entity_info: { display_name: "Zylker Creation", email_id: "reyansh.ahuja@zylker.com", avatar_url: "https://contacts.zoho.com/file?t=user&ID=747938058&fs=thumb&nps=404" }, share_to_member_type: 1, role_id: 34, shared_time_i18: "Apr 14, 5:23 PM", shared_time: "Apr 14, 5:23 PM", shared_status: "ACTIVE", can_link_to_docs: true, owner: "747937818", allow_sharing_outside: false, shared_type: "personal", shared_to_entity: "Zylker Creation", delete_from_propagated_space: false, display_name: "Zylker Creation", message: "", share_to: "747938058", is_expired: false, shared_to_member_type: 1, avatar_url: "https://contacts.zoho.com/file?t=user&ID=747938058&fs=thumb&nps=404", is_password_protected: false, resource_id: "jxtee81865c6d7ed64dc596540aa30dfd2753", permalink: "https://www.zohoapis.com/workdrive/file/jxtee81865c6d7ed64dc596540aa30dfd2753", shared_by_zuid: "747938014" }, links: { self: "https://www.zohoapis.com/workdrive/permissions/jxtee81865c6d7ed64dc596540aa30dfd2753-747938058" } } }
Show fullShare Files/Folders to Group Members
This API will share the file or folder with a WorkDrive group. This will give file/folder access to all the group members.
Request Body Parameters
resource_idstring | |
shared_typestring | |
role_idint | |
share_tostring |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/permissions
{ data: { attributes: { resource_id: "cjrrr81bad43595d94a5bbbb4ea1589ef9236", shared_type: "groupmembers", role_id: "34", share_to: "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021" }, type: "permissions" } }
Example Response
{ data: [ { id: "cjrrr81bad43595d94a5bbbb4ea1589ef9236-2774428000000002021", type: "permissions", attributes: { shared_time_in_millis: 1618922463436, shared_by: "Zylker Creation", expiry_in_millis: 0, relation_type: 0, expiration_date: "Jan 1, 1970, 5:30 AM", share_to_entity_info: { display_name: "Managers - Engg", avatar_url: "https://js.zohostatic.com/personal/stable/jsapps/ui-lab/dist/assets/dev/svg-icons/common/groups_logo-1b99e1d06fa5e3bb404e335e6ce2f43a.svg", type: 1, collaborators_count: 1 }, share_to_member_type: 1, role_id: 34, shared_time_i18: "Apr 20, 6:11 PM", shared_time: "Apr 20, 6:11 PM", shared_status: "ACTIVE", can_link_to_docs: true, owner: "747937818", allow_sharing_outside: false, shared_type: "groupmembers", shared_to_entity: "Managers - Engg", delete_from_propagated_space: false, display_name: "Managers - Engg", message: "", share_to: "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021", is_expired: false, shared_to_member_type: 1, avatar_url: "https://js.zohostatic.com/personal/stable/jsapps/ui-lab/dist/assets/dev/svg-icons/common/groups_logo-1b99e1d06fa5e3bb404e335e6ce2f43a.svg", is_password_protected: false, resource_id: "cjrrr81bad43595d94a5bbbb4ea1589ef9236", permalink: "https://workdrive.zoho.com/folder/cjrrr81bad43595d94a5bbbb4ea1589ef9236", shared_by_zuid: "747938014" }, links: { self: "https://www.zohoapis.com/workdrive/permissions/cjrrr81bad43595d94a5bbbb4ea1589ef9236-2774428000000002021" } } ] }
Show fullShare Files/Folders to everyone on the Internet
This API will give the file or folder access to everyone on the internet.
External users will only be able to view and download files and folders.
Request Body Parameters
resource_idstring | |
shared_typestring | |
role_idint |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/permissions
{ data: { attributes: { resource_id: "cjrrr55b395f872ad4b0a8c52b02eab98c1c5", shared_type: "everyone", role_id: "34" }, type: "permissions" } }
Example Response
{ data: { id: "cjrrr55b395f872ad4b0a8c52b02eab98c1c5-everyone", type: "permissions", attributes: { owner: "747937818", allow_sharing_outside: false, shared_type: "everyone", shared_time_in_millis: 1618922937227, shared_by: "Zylker Creation", expiry_in_millis: 0, delete_from_propagated_space: false, relation_type: 0, expiration_date: "", message: "", share_to_entity_info: {}, share_to: "everyone", share_to_member_type: 1, is_expired: false, shared_to_member_type: 1, role_id: 34, shared_time_i18: "Apr 20, 6:18 PM", shared_time: "Apr 20, 6:18 PM", is_password_protected: false, resource_id: "cjrrr55b395f872ad4b0a8c52b02eab98c1c5", shared_status: "ACTIVE", permalink: "https://workdrive.zohoexternal.com/file/cjrrr55b395f872ad4b0a8c52b02eab98c1c5", shared_by_zuid: "747938014", can_link_to_docs: true }, links: { self: "https://www.zohoapis.com/workdrive/permissions/cjrrr55b395f872ad4b0a8c52b02eab98c1c5-everyone" } } }
Show fullGenerate Embed Code for a Files/Folders
This API will create published permalink_url for files and folders to share the file to the external world.
One can place the permalink_url generated in an src (source) attribute of a website or blog's IFRAME.
External Users can view, download, and print the embedded files and folders from websites and blogs.
Request Body Parameters
resource_idstring | Mandatory The unique ID of the file. |
shared_typestring | |
role_idint | Mandatory Allowed role ID for files / folders: 34 - View |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/permissions
{ data: { attributes: { resource_id: "cjrrr55b395f872ad4b0a8c52b02eab98c1c5", shared_type: "publish", role_id: "34" }, type: "permissions" } }
Example Response
{ data: { id: "cjrrr55b395f872ad4b0a8c52b02eab98c1c5-public", type: "permissions", attributes: { owner: "747937818", allow_sharing_outside: false, shared_type: "publish", shared_time_in_millis: 1618923070525, shared_by: "Zylker Creation", expiry_in_millis: 0, delete_from_propagated_space: false, relation_type: 0, expiration_date: "", message: "", share_to_entity_info: {}, share_to: "public", share_to_member_type: 1, is_expired: false, shared_to_member_type: 1, role_id: 34, shared_time_i18: "Apr 20, 6:21 PM", shared_time: "Apr 20, 6:21 PM", is_password_protected: false, resource_id: "cjrrr55b395f872ad4b0a8c52b02eab98c1c5", shared_status: "ACTIVE", permalink: "https://workdrive.zohoexternal.com/file/cjrrr55b395f872ad4b0a8c52b02eab98c1c5", shared_by_zuid: "747938014", can_link_to_docs: true }, links: { self: "https://www.zohoapis.com/workdrive/permissions/cjrrr55b395f872ad4b0a8c52b02eab98c1c5-public" } } }
Show fullShare Files/Folders to Individual Team Members
This API will share the files or folders with individual team members personally via their email ids.
Request Body Parameters
resource_idstring | |
shared_typestring | |
email_idstring | |
role_idint | |
send_notification_mailboolean |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/permissions
{ data: { attributes: { resource_id: "cjrrrbba68351fce045a986ea712783c38fe6", shared_type: "personal", email_id: "reyansh.ahuja@zylker.com", role_id: "5", send_notification_mail: "true" }, type: "permissions" } }
Example Response
{ data: [ { id: "cjrrrbba68351fce045a986ea712783c38fe6-747938058", type: "permissions", attributes: { email_id: "reyansh.ahuja@zylker.com", shared_time_in_millis: 1618923400449, shared_by: "Zylker Creation", expiry_in_millis: 0, relation_type: 0, expiration_date: "Jan 1, 1970, 5:30 AM", share_to_entity_info: { display_name: "Zylker Creation", email_id: "reyansh.ahuja@zylker.com", avatar_url: "https://contacts.zoho.com/file?t=user&ID=747938058&fs=thumb&nps=404" }, share_to_member_type: 1, role_id: 5, shared_time_i18: "Apr 20, 6:26 PM", shared_time: "Apr 20, 6:26 PM", shared_status: "ACTIVE", can_link_to_docs: true, owner: "747937818", allow_sharing_outside: false, shared_type: "personal", shared_to_entity: "Zylker Creation", delete_from_propagated_space: false, display_name: "Zylker Creation", message: "", share_to: "747938058", is_expired: false, shared_to_member_type: 1, avatar_url: "https://contacts.zoho.com/file?t=user&ID=747938058&fs=thumb&nps=404", is_password_protected: false, resource_id: "cjrrrbba68351fce045a986ea712783c38fe6", permalink: "https://workdrive.zoho.com/file/cjrrrbba68351fce045a986ea712783c38fe6", shared_by_zuid: "747938014" }, links: { self: "https://www.zohoapis.com/workdrive/permissions/cjrrrbba68351fce045a986ea712783c38fe6-747938058" } } ] }
Show fullShare Files/Folders with Team
This API will share the file or folders with all team members in a team.
Request Body Parameters
resource_idstring | |
shared_typestring | |
role_idint |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/permissions
{ data: { attributes: { resource_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", shared_type: "teammembers", role_id: "5" }, type: "permissions" } }
Example Response
{ data: { id: "cjrrrbba68351fce045a986ea712783c38fe6-ly9zmae16b43c258f458a9a57ac02c4f8d763", type: "permissions", attributes: { shared_time_in_millis: 1618923194395, shared_by: "Zylker Creation", expiry_in_millis: 0, relation_type: 0, expiration_date: "", share_to_entity_info: {}, share_to_member_type: 1, role_id: 34, shared_time_i18: "Apr 20, 6:23 PM", shared_time: "Apr 20, 6:23 PM", shared_status: "ACTIVE", can_link_to_docs: true, owner: "747937818", allow_sharing_outside: false, shared_type: "teammembers", shared_to_entity: "Zylker Creation Limited", delete_from_propagated_space: false, message: "", share_to: "ly9zmae16b43c258f458a9a57ac02c4f8d763", is_expired: false, shared_to_member_type: 1, is_password_protected: false, resource_id: "cjrrrbba68351fce045a986ea712783c38fe6", permalink: "https://workdrive.zoho.com/file/cjrrrbba68351fce045a986ea712783c38fe6", shared_by_zuid: "747938014" }, links: { self: "https://www.zohoapis.com/workdrive/permissions/cjrrrbba68351fce045a986ea712783c38fe6-ly9zmae16b43c258f458a9a57ac02c4f8d763" } } }
Show fullUpdate File/Folder Share Permissions
This API will update the roles of the users with whom the files need to be shared.
The permission_id is created when the file or folder is shared with other users.
Path Parameters
permission_idstring | Mandatory The unique ID that represents collaboration. |
Request Body Parameters
role_idint | Mandatory The new role ID provided to the user. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/permissions/{permission_id}
{ data: { attributes: { role_id: "5" }, type: "permissions" } }
Example Response
{ data: { id: "cjrrr81bad43595d94a5bbbb4ea1589ef9236-747938058", type: "permissions", attributes: { email_id: "reyansh.ahuja@zylker.com", shared_time_in_millis: 1618298370952, shared_by: "Zylker Creation", expiry_in_millis: 0, relation_type: 0, expiration_date: "Jan 1, 1970, 5:30 AM", share_to_entity_info: { display_name: "Zylker Creation", email_id: "reyansh.ahuja@zylker.com", avatar_url: "https://contacts.zoho.com/file?t=user&ID=747938058&fs=thumb&nps=404" }, share_to_member_type: 1, role_id: 5, shared_time_i18: "Apr 13, 12:49 PM", shared_time: "Apr 13, 12:49 PM", shared_status: "ACTIVE", can_link_to_docs: true, owner: "747937818", allow_sharing_outside: false, shared_type: "personal", shared_to_entity: "Zylker Creation", delete_from_propagated_space: false, display_name: "Zylker Creation", message: "", share_to: "747938058", is_expired: false, shared_to_member_type: 1, avatar_url: "https://contacts.zoho.com/file?t=user&ID=747938058&fs=thumb&nps=404", is_password_protected: false, resource_id: "cjrrr81bad43595d94a5bbbb4ea1589ef9236", permalink: "https://www.zohoapis.com/workdrive/folder/cjrrr81bad43595d94a5bbbb4ea1589ef9236", shared_by_zuid: "747938014" }, links: { self: "https://www.zohoapis.com/workdrive/permissions/cjrrr81bad43595d94a5bbbb4ea1589ef9236-747938058" } } }
Show fullDelete File/Folder Share Access
This API will stop sharing the file/folder and remove access.
Path Parameters
permission_idstring | Mandatory The unique ID that represents collaboration. |
Example Request
DELETE https://www.zohoapis.com/workdrive/api/v1/permissions/{permission_id}
Example Response
204: No Content
Search
WorkDrive allows its users to search for files and folders using the file name, the folder name, the author's name, or a keyword inside the content of a file.
It is also possible to apply filters to narrow down the search results further.
Search across Team
This API searches for data across all available teams in a WorkDrive account.
Path Parameters
team_idstring | Mandatory The unique ID of the team. |
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
search[all|name|content]string | Mandatory all: Search using all the criteria. name: Search file name alone. content: Search the content of file alone. Eg. search[all]={query} |
filter[type]string | Optional To Search specific file type. Eg. filter[type]=documents For list of filter type, see file filter in Filters page. Refer here |
filter[date]string | Optional To search Resource by predefined date filter. Eg. filter[date]=today Types:
|
filter[fromDate]string | Optional To search from a particular Date. |
filter[toDate]string | Optional To search till a particular Date. |
filter[status]string | Optional To search resources by its current state. Eg. filter[status]=trashed Status:
|
filter[creator]string | Optional To search resources by its creator. Eg. filter[creator]={zuid} |
page[limit]string | Optional Limit indicates the number of items to be listed. 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:
|
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/teams/{team_id}/records?search%5Ball%5D={query}&page%5Blimit%5D=50&page%5Boffset%5D=0
Example Response
{ data: [ { id: "cjrrr81bad43595d94a5bbbb4ea1589ef9236", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 0, is_fillable_resource: false, is_published: false, destination_id: "ly9zme5724e019a8e4cb48632945b1296be0a", storage_info: { files_count: 0, folders_count: 0, size_in_bytes: 0, storage_used_in_bytes: 0 }, team_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", type: "folder", created_time_i18: "Apr 13, 12:25 PM", modified_time_in_millisecond: 1618296919142, opened_time: "Apr 13, 12:25 PM", status_change_time: "Apr 13, 12:25 PM", download_url: "https://www.zohoapis.com/workdrive/download/cjrrr81bad43595d94a5bbbb4ea1589ef9236", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 13, 12:25 PM", lock_status: 2, is_folder: true, resource_type: 1001, is_email_in_upload: false, display_attr_name: "Notes", created_by: "Zylker Creation", display_html_name: "Notes", labels: [], parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a", name: "Notes", status_change_time_in_millisecond: 1618296919142, permalink: "https://www.zohoapis.com/workdrive/folder/cjrrr81bad43595d94a5bbbb4ea1589ef9236", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Apr 13, 12:25 PM", opened_time_i18: "Apr 13, 12:25 PM", extn: "", view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, shortcut_link: "", status_change_time_i18: "Apr 13, 12:25 PM", description: "", uploaded_time_in_millisecond: 1618296919146, thumbnail_url: "", title: "", files_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, modified_time: "Apr 13, 12:25 PM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "folder", created_time_in_millisecond: 1618296919142, owner: "747937818", creator: "747938014", uploaded_time_i18: "Apr 13, 12:25 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618296919142, edit_badge_count: 0, share_data: [], uploaded_time: "Apr 13, 12:25 PM", has_folders: false, service_type: "upload", display_url_name: "Notes", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/files", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/links", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236" } } ], meta: { search_result_count: 1 } }
Show fullSearch across Team Folder
This API searches for data across a selected team folder.
Path Parameters
team_idstring | Mandatory The unique ID of the team. |
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
search[all|name|content]string | Mandatory all: Search using all the criteria. name: Search file name alone. content: Search the content of file alone. Eg. search[all]={query} |
filter[teamFolder]string | Mandatory To search in a specific team folder. Eg. filter[teamFolder]={teamfolder_id} |
filter[type]string | Optional To Search specific file type. Eg. filter[type]=documents For list of filter type, see file filter in Filters page. Refer here |
filter[date]string | Optional To search resource by predefined date filter. Eg. filter[date]=today Types:
|
filter[fromDate]string | Optional To search from a particular Date. |
filter[toDate]string | Optional To search till a particular Date. |
filter[status]string | Optional To search resources by its current state. Eg. filter[status]=trashed Status:
|
filter[creator]string | Optional To search resources by its creator. Eg. filter[creator]={zuid} |
page[limit]string | Optional Limit indicates the number of items to be listed. 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:
|
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/teams/{team_id}/records?search%5Ball%5D={query}&filter%5BteamFolder%5D={teamfolder_id}&page%5Blimit%5D=50&page%5Boffset%5D=0
Example Response
{ data: [ { id: "cjrrr81bad43595d94a5bbbb4ea1589ef9236", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 0, is_fillable_resource: false, is_published: false, destination_id: "ly9zme5724e019a8e4cb48632945b1296be0a", storage_info: { files_count: 0, folders_count: 0, size_in_bytes: 0, storage_used_in_bytes: 0 }, team_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", type: "folder", created_time_i18: "Apr 13, 12:25 PM", modified_time_in_millisecond: 1618296919142, opened_time: "Apr 13, 12:25 PM", status_change_time: "Apr 13, 12:25 PM", download_url: "https://www.zohoapis.com/workdrive/download/cjrrr81bad43595d94a5bbbb4ea1589ef9236", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 13, 12:25 PM", lock_status: 2, is_folder: true, resource_type: 1001, is_email_in_upload: false, display_attr_name: "Notes", created_by: "Zylker Creation", display_html_name: "Notes", labels: [], parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a", name: "Notes", status_change_time_in_millisecond: 1618296919142, permalink: "https://www.zohoapis.com/workdrive/folder/cjrrr81bad43595d94a5bbbb4ea1589ef9236", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Apr 13, 12:25 PM", opened_time_i18: "Apr 13, 12:25 PM", extn: "", view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, shortcut_link: "", status_change_time_i18: "Apr 13, 12:25 PM", description: "", uploaded_time_in_millisecond: 1618296919146, thumbnail_url: "", title: "", files_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, modified_time: "Apr 13, 12:25 PM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "folder", created_time_in_millisecond: 1618296919142, owner: "747937818", creator: "747938014", uploaded_time_i18: "Apr 13, 12:25 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618296919142, edit_badge_count: 0, share_data: [], uploaded_time: "Apr 13, 12:25 PM", has_folders: false, service_type: "upload", display_url_name: "Notes", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/files", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/links", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236" } } ], meta: { search_result_count: 1 } }
Show fullSearch in My Folders
This API searches for data in their own my folders section.
Path Parameters
team_idstring | Mandatory The unique ID of the team. |
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
search[all|name|content]string | Mandatory all: Search using all the criteria. name: Search file name alone. content: Search the content of file alone. Eg. search[all]={query} |
filter[user]string | Mandatory To search in a specific user's My Folders. Eg. filter[user]={zuid} |
filter[type]string | Optional To Search specific file type. Eg. filter[type]=documents For list of filter type, see file filter in Filters page. Refer here |
filter[date]string | Optional To search resource by predefined date filter. Eg. filter[date]=today Types
|
filter[fromDate]string | Optional To search from a particular Date. |
filter[toDate]string | Optional To search till a particular Date. |
filter[status]string | Optional To search resources by its current state. Eg. filter[status]=trashed Status:
|
page[limit]string | Optional Limit indicates the number of items to be listed. 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
|
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/teams/{team_id}/records?search%5Ball%5D={query}&filter%5Buser%5D={zuid}&page%5Blimit%5D=50&page%5Boffset%5D=0
Example Response
{ data: [ { id: "cjrrr81bad43595d94a5bbbb4ea1589ef9236", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 0, is_fillable_resource: false, is_published: false, destination_id: "ly9zme5724e019a8e4cb48632945b1296be0a", storage_info: { files_count: 0, folders_count: 0, size_in_bytes: 0, storage_used_in_bytes: 0 }, team_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", type: "folder", created_time_i18: "Apr 13, 12:25 PM", modified_time_in_millisecond: 1618296919142, opened_time: "Apr 13, 12:25 PM", status_change_time: "Apr 13, 12:25 PM", download_url: "https://www.zohoapis.com/workdrive/download/cjrrr81bad43595d94a5bbbb4ea1589ef9236", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 13, 12:25 PM", lock_status: 2, is_folder: true, resource_type: 1001, is_email_in_upload: false, display_attr_name: "Notes", created_by: "Zylker Creation", display_html_name: "Notes", labels: [], parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a", name: "Notes", status_change_time_in_millisecond: 1618296919142, permalink: "https://www.zohoapis.com/workdrive/folder/cjrrr81bad43595d94a5bbbb4ea1589ef9236", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Apr 13, 12:25 PM", opened_time_i18: "Apr 13, 12:25 PM", extn: "", view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, shortcut_link: "", status_change_time_i18: "Apr 13, 12:25 PM", description: "", uploaded_time_in_millisecond: 1618296919146, thumbnail_url: "", title: "", files_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, modified_time: "Apr 13, 12:25 PM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "folder", created_time_in_millisecond: 1618296919142, owner: "747937818", creator: "747938014", uploaded_time_i18: "Apr 13, 12:25 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618296919142, edit_badge_count: 0, share_data: [], uploaded_time: "Apr 13, 12:25 PM", has_folders: false, service_type: "upload", display_url_name: "Notes", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/files", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/links", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236" } } ], meta: { search_result_count: 1 } }
Show fullSearch across Folder
This API searches for data across a selected folder.
Path Parameters
team_idstring | Mandatory The unique ID of the team. |
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
search[all|name|content]string | Mandatory all: Search using all the criteria. name: Search file name alone. content: Search the content of file alone. Eg. search[all]={query} |
filter[parentId]string | Mandatory To search in a specific folder. Eg. filter[parentId]={parentfolder_id} |
filter[type]string | Optional To Search specific file type. Eg. filter[type]=documents For list of filter type, see file filter in Filters page. Refer here |
filter[date]string | Optional To search resource by predefined date filter. Eg. filter[date]=today Types:
|
filter[fromDate]string | Optional To search from a particular Date. |
filter[toDate]string | Optional To search till a particular Date. |
filter[status]string | Optional To search resources by its current state. Eg. filter[status]=trashed Status:
|
filter[creator]string | Optional To search resources by its creator. Eg. filter[creator]={zuid} |
page[limit]string | Optional Limit indicates the number of items to be listed. 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:
|
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/teams/{team_id}/records?search%5Ball%5D={query}&filter%5BparentId%5D={parentfolder_id}&page%5Blimit%5D=50&page%5Boffset%5D=0
Example Response
{ data: [ { id: "cjrrr81bad43595d94a5bbbb4ea1589ef9236", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 0, is_fillable_resource: false, is_published: false, destination_id: "ly9zme5724e019a8e4cb48632945b1296be0a", storage_info: { files_count: 0, folders_count: 0, size_in_bytes: 0, storage_used_in_bytes: 0 }, team_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", type: "folder", created_time_i18: "Apr 13, 12:25 PM", modified_time_in_millisecond: 1618296919142, opened_time: "Apr 13, 12:25 PM", status_change_time: "Apr 13, 12:25 PM", download_url: "https://www.zohoapis.com/workdrive/download/cjrrr81bad43595d94a5bbbb4ea1589ef9236", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 13, 12:25 PM", lock_status: 2, is_folder: true, resource_type: 1001, is_email_in_upload: false, display_attr_name: "Notes", created_by: "Zylker Creation", display_html_name: "Notes", labels: [], parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a", name: "Notes", status_change_time_in_millisecond: 1618296919142, permalink: "https://www.zohoapis.com/workdrive/folder/cjrrr81bad43595d94a5bbbb4ea1589ef9236", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Apr 13, 12:25 PM", opened_time_i18: "Apr 13, 12:25 PM", extn: "", view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, shortcut_link: "", status_change_time_i18: "Apr 13, 12:25 PM", description: "", uploaded_time_in_millisecond: 1618296919146, thumbnail_url: "", title: "", files_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, modified_time: "Apr 13, 12:25 PM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "folder", created_time_in_millisecond: 1618296919142, owner: "747937818", creator: "747938014", uploaded_time_i18: "Apr 13, 12:25 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618296919142, edit_badge_count: 0, share_data: [], uploaded_time: "Apr 13, 12:25 PM", has_folders: false, service_type: "upload", display_url_name: "Notes", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/files", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/links", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236" } } ], meta: { search_result_count: 1 } }
Show fullSearch in Shared with Me
This API searches for data in the "Shared with Me" section.
The "Shared with me" section will have all files and folders shared with the user directly by other users or via groups.
Path Parameters
team_idstring |
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
search[all|name|content]string | all: Search using all the criteria. name: Search file name alone. content: Search the content of file alone Eg. search[all]={query} |
filter[sharedResources]string | To search in the data shared to this user. Eg. filter[sharedResources]={zuid} |
filter[type]string | To Search specific file type. Eg. filter[type]=documents For list of filter type, see file filter in Filters page. Refer here |
filter[date]string | To search resource by predefined date filter. Eg. filter[date]=today Types:
|
filter[fromDate]string | |
filter[toDate]string | |
filter[status]string | To search resources by its current state. Eg. filter[status]=trashed Status:
|
filter[creator]string | To search resources by its creator. Eg. filter[creator]={zuid} |
page[limit]string | For More Details about pagination. Refer here |
page[offset]string | |
sortstring | Sorting can be done with these fields.
|
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/teams/{team_id}/records?search%5Ball%5D={query}&filter%5BsharedResources%5D={zuid}&page%5Blimit%5D=50&page%5Boffset%5D=0
Example Response
{ data: [ { id: "cjrrr81bad43595d94a5bbbb4ea1589ef9236", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 0, is_fillable_resource: false, is_published: false, destination_id: "ly9zme5724e019a8e4cb48632945b1296be0a", storage_info: { files_count: 0, folders_count: 0, size_in_bytes: 0, storage_used_in_bytes: 0 }, team_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", type: "folder", created_time_i18: "Apr 13, 12:25 PM", modified_time_in_millisecond: 1618296919142, opened_time: "Apr 13, 12:25 PM", status_change_time: "Apr 13, 12:25 PM", download_url: "https://www.zohoapis.com/workdrive/download/cjrrr81bad43595d94a5bbbb4ea1589ef9236", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 13, 12:25 PM", lock_status: 2, is_folder: true, resource_type: 1001, is_email_in_upload: false, display_attr_name: "Notes", created_by: "Zylker Creation", display_html_name: "Notes", labels: [], parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a", name: "Notes", status_change_time_in_millisecond: 1618296919142, permalink: "https://www.zohoapis.com/workdrive/folder/cjrrr81bad43595d94a5bbbb4ea1589ef9236", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Apr 13, 12:25 PM", opened_time_i18: "Apr 13, 12:25 PM", extn: "", view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, shortcut_link: "", status_change_time_i18: "Apr 13, 12:25 PM", description: "", uploaded_time_in_millisecond: 1618296919146, thumbnail_url: "", title: "", files_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, modified_time: "Apr 13, 12:25 PM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "folder", created_time_in_millisecond: 1618296919142, owner: "747937818", creator: "747938014", uploaded_time_i18: "Apr 13, 12:25 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618296919142, edit_badge_count: 0, share_data: [], uploaded_time: "Apr 13, 12:25 PM", has_folders: false, service_type: "upload", display_url_name: "Notes", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/files", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/links", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236" } } ], meta: { search_result_count: 1 } }
Show fullSearch based on Data Template
This API searches for data based on data templates associated with the files.
Path Parameters
team_idstring | Mandatory The unique ID of the team. |
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
search[all|name|content]string | Mandatory all: Search using all the criteria. name: Search file name alone. content: Search the content of file alone. Eg. search[all]={query} |
filter[datatemplate]string | Mandatory To search resources associated to a specific date template.
|
filter[customFields]string | Optional To filter files and folders by adding custom field criteria.
Note: value refers to the value you enter to filter search results |
filter[type]string | Optional To search specific file type Eg. filter[type]=documents For list of filter type, see file filter in Filters page. Refer here |
filter[date]string | Optional To search Resource by predefined date filter. Eg. filter[date]=today Types:
|
filter[fromDate]string | Optional To search from a particular Date. |
filter[toDate]string | Optional To search till a particular Date. |
filter[status]string | Optional To search Resources by its current state. Eg. filter[status]=trashed Status:
|
filter[creator]string | Optional To search Resources by its creator. Eg. filter[creator]={zuid} |
page[limit]string | Optional Limit indicates the number of items to be listed. 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.
|
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/teams/{team_id}/records?search%5Ball%5D={query}&filter%5Bdatatemplate%5D={data_template_id}&page%5Blimit%5D=50&page%5Boffset%5D=0
Example Response
{ data: [ { id: "cjrrr81bad43595d94a5bbbb4ea1589ef9236", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 0, is_fillable_resource: false, is_published: false, destination_id: "ly9zme5724e019a8e4cb48632945b1296be0a", storage_info: { files_count: 0, folders_count: 0, size_in_bytes: 0, storage_used_in_bytes: 0 }, team_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", type: "folder", created_time_i18: "Apr 13, 12:25 PM", modified_time_in_millisecond: 1618296919142, opened_time: "Apr 13, 12:25 PM", status_change_time: "Apr 13, 12:25 PM", download_url: "https://www.zohoapis.com/workdrive/download/cjrrr81bad43595d94a5bbbb4ea1589ef9236", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 13, 12:25 PM", lock_status: 2, is_folder: true, resource_type: 1001, is_email_in_upload: false, display_attr_name: "Notes", created_by: "Zylker Creation", display_html_name: "Notes", labels: [], parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a", name: "Notes", status_change_time_in_millisecond: 1618296919142, permalink: "https://www.zohoapis.com/workdrive/folder/cjrrr81bad43595d94a5bbbb4ea1589ef9236", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Apr 13, 12:25 PM", opened_time_i18: "Apr 13, 12:25 PM", extn: "", view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, shortcut_link: "", status_change_time_i18: "Apr 13, 12:25 PM", description: "", uploaded_time_in_millisecond: 1618296919146, thumbnail_url: "", title: "", files_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, modified_time: "Apr 13, 12:25 PM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "folder", created_time_in_millisecond: 1618296919142, owner: "747937818", creator: "747938014", uploaded_time_i18: "Apr 13, 12:25 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618296919142, edit_badge_count: 0, share_data: [], uploaded_time: "Apr 13, 12:25 PM", has_folders: false, service_type: "upload", display_url_name: "Notes", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/files", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/links", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236" } } ], meta: { search_result_count: 1 } }
Show fullGroups
WorkDrive allows the users to create groups based on members' roles or profiles in the organization and easily add the group members to team folders.
Note:
Only Team Admins can create groups in WorkDrive. Multiple groups can be assigned to users and they can access data according to the permissions assigned to each group
Get List of Group Members
This API lists all members in a group.
Path Parameters
group_idstring | Mandatory The unique ID of the group. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/groups/{group_id}/groupmembers
Example Response
{ data: [ { id: "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002022", type: "groupmembers", attributes: { member_id: 2774428000000002000, email_id: "zylker@zylker.com", added_time: "Apr 13, 12:15 AM", capabilities: { can_read: true, can_delete: true, can_edit: true, can_rename: true, can_add_members: true }, display_name: "Zylker Creation", modified_time: "Apr 13, 12:15 AM", avatar_url: "https://contacts.zoho.com/file?t=user&ID=747938014&fs=thumb&nps=404", group_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021", role_id: 30, added_by: "Zylker Creation", modified_by: "Zylker Creation", member_zuid: "747938014", status: 1 }, links: { self: "https://www.zohoapis.com/workdrive/groupmembers/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002022" } } ] }
Show fullGet Group Info
This API fetches information about a group.
Note:
Only members of this group or members with admin-level permissions will be able to get information about the group.
Path Parameters
group_idstring | Mandatory The unique ID of the group. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/groups/{group_id}
Example Response
{ data: { id: "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021", type: "groups", attributes: { owner: "747937818", created_time: "Apr 13, 12:15 AM", capabilities: { can_read: true, can_delete: true, can_edit: true, can_trash: true, can_rename: true, can_restore: true, can_add_members: true }, description: "", type: 1, created_by: "Zylker Creation", modified_time: "Apr 13, 12:15 AM", avatar_url: "https://js.zohostatic.com/personal/stable/jsapps/ui-lab/dist/assets/dev/svg-icons/common/groups_logo-1b99e1d06fa5e3bb404e335e6ce2f43a.svg", parent_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", name: "Managers", modified_by: "Zylker Creation", members_count: 1, status: 1 }, relationships: { groupmembers: { links: { self: "https://www.zohoapis.com/workdrive/groups/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021/relationships/groupmembers", related: "https://www.zohoapis.com/workdrive/groups/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021/groupmembers" } } }, links: { self: "https://www.zohoapis.com/workdrive/groups/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021" } } }
Show fullCreate Group
This API creates a new user group in a WorkDrive team.
Request Body Parameters
namestring | Mandatory The name of the group. |
parent_idstring | Mandatory The unique ID of the team. |
descriptionstring | Optional A detailed overview of the group. |
typeint | Mandatory The type of the group:
|
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/groups
{ data: { attributes: { name: "Employees", parent_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", description: "Groups for employees", type: "1" }, type: "groups" } }
Example Response
{ data: [ { id: "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002020", type: "groups", attributes: { owner: "747937818", created_time: "Apr 13, 12:15 AM", capabilities: { can_read: true, can_delete: true, can_edit: true, can_trash: true, can_rename: true, can_restore: true, can_add_members: true }, description: "", type: 1, created_by: "Zylker Creation", modified_time: "Apr 13, 12:15 AM", avatar_url: "https://js.zohostatic.com/personal/stable/jsapps/ui-lab/dist/assets/dev/svg-icons/common/groups_logo-1b99e1d06fa5e3bb404e335e6ce2f43a.svg", parent_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", name: "Employees", modified_by: "Zylker Creation", members_count: 1, status: 1 }, relationships: { groupmembers: { links: { self: "https://www.zohoapis.com/workdrive/groups/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002020/relationships/groupmembers", related: "https://www.zohoapis.com/workdrive/groups/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002020/groupmembers" } } }, links: { self: "https://www.zohoapis.com/workdrive/groups/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002020" } }, { id: "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021", type: "groups", attributes: { owner: "747937818", created_time: "Apr 13, 12:15 AM", capabilities: { can_read: true, can_delete: true, can_edit: true, can_trash: true, can_rename: true, can_restore: true, can_add_members: true }, description: "", type: 1, created_by: "Zylker Creation", modified_time: "Apr 13, 12:15 AM", avatar_url: "https://js.zohostatic.com/personal/stable/jsapps/ui-lab/dist/assets/dev/svg-icons/common/groups_logo-1b99e1d06fa5e3bb404e335e6ce2f43a.svg", parent_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", name: "Managers", modified_by: "Zylker Creation", members_count: 1, status: 1 }, relationships: { groupmembers: { links: { self: "https://www.zohoapis.com/workdrive/groups/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021/relationships/groupmembers", related: "https://www.zohoapis.com/workdrive/groups/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021/groupmembers" } } }, links: { self: "https://www.zohoapis.com/workdrive/groups/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021" } } ] }
Show fullRename Group
This API helps in renaming a group.
Note:
Only the team member, who created the group, can update the name of the group.
Path Parameters
group_idstring | Mandatory The unique ID of the group. |
Request Body Parameters
namestring | Mandatory The new name of the group. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/groups/{group_id}
{ data: { attributes: { name: "Managers - Engg" }, type: "groups" } }
Example Response
{ data: { id: "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021", type: "groups", attributes: { owner: "747937818", created_time: "Apr 13, 12:15 AM", capabilities: { can_read: true, can_delete: true, can_edit: true, can_trash: true, can_rename: true, can_restore: true, can_add_members: true }, description: "", type: 1, created_by: "Zylker Creation", modified_time: "Apr 13, 12:23 AM", avatar_url: "https://js.zohostatic.com/personal/stable/jsapps/ui-lab/dist/assets/dev/svg-icons/common/groups_logo-1b99e1d06fa5e3bb404e335e6ce2f43a.svg", parent_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", name: "Managers - Engg", modified_by: "Zylker Creation", members_count: 1, status: 1 }, relationships: { groupmembers: { links: { self: "https://www.zohoapis.com/workdrive/groups/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021/relationships/groupmembers", related: "https://www.zohoapis.com/workdrive/groups/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021/groupmembers" } } }, links: { self: "https://www.zohoapis.com/workdrive/groups/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021" } } }
Show fullUpdate Group Description
This API helps in changing the description of a group.
Note:
Only the team member, who created the group, can update the description of the group.
Path Parameters
group_idstring | Mandatory The unique ID of the group. |
Request Body Parameters
descriptionstring | Mandatory A brief description about the group. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/groups/{group_id}
{ data: { attributes: { description: "Engineering managers group" }, type: "groups" } }
Example Response
{ data: { id: "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021", type: "groups", attributes: { owner: "747937818", created_time: "Apr 13, 12:15 AM", capabilities: { can_read: true, can_delete: true, can_edit: true, can_trash: true, can_rename: true, can_restore: true, can_add_members: true }, description: "Engineering managers group", type: 1, created_by: "Zylker Creation", modified_time: "Apr 13, 12:24 AM", avatar_url: "https://js.zohostatic.com/personal/stable/jsapps/ui-lab/dist/assets/dev/svg-icons/common/groups_logo-1b99e1d06fa5e3bb404e335e6ce2f43a.svg", parent_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", name: "Managers - Engg", modified_by: "Zylker Creation", members_count: 1, status: 1 }, relationships: { groupmembers: { links: { self: "https://www.zohoapis.com/workdrive/groups/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021/relationships/groupmembers", related: "https://www.zohoapis.com/workdrive/groups/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021/groupmembers" } } }, links: { self: "https://www.zohoapis.com/workdrive/groups/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021" } } }
Show fullDelete Group
This API deletes a group.
Note:
Only the team member, who created the group, can delete the group.
Path Parameters
group_idstring | Mandatory The unique ID of the group. |
Example Request
DELETE https://www.zohoapis.com/workdrive/api/v1/groups/{group_id}
Example Response
204: No Content
Group Members
Group members are the one who get added to the WorkDrive group and assign each a group role: Group Admin or Group Member.
You can assign users to multiple groups and they can access data according to the permissions assigned to each group.
Get Group Member Info
This API fetches the required information about a group member.
Path Parameters
group_member_idstring | Mandatory The unique ID of the group member. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/groupmembers/{group_member_id}
Example Response
{ data: { id: "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002023", type: "groupmembers", attributes: { member_id: 2774428000000002000, email_id: "reyansh.ahuja@zylker.com", added_time: "Apr 13, 12:25 AM", capabilities: { can_read: true, can_delete: true, can_edit: true, can_rename: true, can_add_members: true }, display_name: "Zylker Creation", modified_time: "Apr 13, 12:25 AM", avatar_url: "https://contacts.zoho.com/file?t=user&ID=747938058&fs=thumb&nps=404", group_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021", role_id: 31, added_by: "Zylker Creation", modified_by: "Zylker Creation", member_zuid: "747938058", status: 1 }, links: { self: "https://www.zohoapis.com/workdrive/groupmembers/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002023" } } }
Show fullAdd Multiple Members to Group
This API helps in adding multiple new members to a WorkDrive group.
Request Body Parameters
member_zuidstring | Mandatory The unique ID that represents group members. |
group_idstring | Mandatory The unique ID of the group, where one needs to add new members. |
role_idint | Mandatory Allowed values for group member role:
|
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/groupmembers
{ data: [ { attributes: { member_zuid: "747938058", group_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002023", role_id: "31" }, type: "groupmembers" }, { attributes: { member_zuid: "747938123", group_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002024", role_id: "31" }, type: "groupmembers" } ] }
Example Response
{ data: [ { id: "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002023", type: "groupmembers", attributes: { member_id: 2774428000000002000, email_id: "reyansh.ahuja@zylker.com", added_time: "Apr 13, 12:25 AM", capabilities: { can_read: true, can_delete: true, can_edit: true, can_rename: true, can_add_members: true }, display_name: "Zylker Creation", modified_time: "Apr 13, 12:25 AM", avatar_url: "https://contacts.zoho.com/file?t=user&ID=747938058&fs=thumb&nps=404", group_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021", role_id: 31, added_by: "Zylker Creation", modified_by: "Zylker Creation", member_zuid: "747938058", status: 1 }, links: { self: "https://www.zohoapis.com/workdrive/groupmembers/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002023" } }, { id: "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002024", type: "groupmembers", attributes: { member_id: 2774428000000002000, email_id: "reyansh.west@zylker.com", added_time: "Apr 13, 12:25 AM", capabilities: { can_read: true, can_delete: true, can_edit: true, can_rename: true, can_add_members: true }, display_name: "Zylker Creation", modified_time: "Apr 13, 12:25 AM", avatar_url: "https://contacts.zoho.com/file?t=user&ID=747938123&fs=thumb&nps=404", group_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021", role_id: 31, added_by: "Zylker Creation", modified_by: "Zylker Creation", member_zuid: "747938123", status: 1 }, links: { self: "https://www.zohoapis.com/workdrive/groupmembers/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002024" } } ] }
Show fullUpdate Group Member Role
This API helps in changing the role of a group member.
Note:
Only the group admins can change the members' role in the group.
Path Parameters
group_member_idstring | Mandatory The unique ID of the group member. |
Request Body Parameters
role_idint | Mandatory Allowed values for group member role:
|
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/groupmembers/{group_member_id}
{ data: { attributes: { role_id: "30" }, type: "groupmembers" } }
Example Response
{ data: { id: "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002023", type: "groupmembers", attributes: { member_id: 2774428000000002000, email_id: "reyansh.ahuja@zylker.com", added_time: "Apr 13, 12:25 AM", capabilities: { can_read: true, can_delete: true, can_edit: true, can_rename: true, can_add_members: true }, display_name: "Zylker Creation", modified_time: "Apr 13, 12:27 AM", avatar_url: "https://contacts.zoho.com/file?t=user&ID=747938058&fs=thumb&nps=404", group_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021", role_id: 30, added_by: "Zylker Creation", modified_by: "Zylker Creation", member_zuid: "747938058", status: 1 }, links: { self: "https://www.zohoapis.com/workdrive/groupmembers/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002023" } } }
Show fullRemove Group Member
This API removes members from a group.
Note:
Only the group admins can remove a member from the group.
Path Parameters
group_member_idstring | Mandatory The unique ID of the group member, who will be removed from the group. |
Example Request
DELETE https://www.zohoapis.com/workdrive/api/v1/groupmembers/{group_member_id}
Example Response
204: No Content
External Sharing
External sharing is sharing files and folders with external users.
One way to share data externally in WorkDrive is through custom share links.
When shared via a custom shared link, users can set passwords and expiration dates, allow or disallow downloads, and even request User information for the shared link to help restrict access and track activity.
Get External Share Link Info
This API fetches information about an external share link.
One can find the following information:
Path Parameters
link_idstring | Mandatory The unique ID of the shared link. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/links/{link_id}
Example Response
{ data: { id: "3iWUoMURXKC-OCgNc", type: "links", attributes: { modified_time_i18: "Apr 13, 1:16 PM", created_time: "Apr 13, 1:16 PM", link: "https://workdrive.zohoexternal.com/external/3iWUoMURXKC-OCgNc", input_fields: [], type: "folder", can_display_profile: false, created_by: "Zylker Creation", use_shorten_link: false, created_time_i18: "Apr 13, 1:16 PM", allow_download: true, request_user_data: false, link_type: "custom", modified_time: "Apr 13, 1:16 PM", is_expired: false, role_id: 34, download_url: "https://workdrive.zohoexternal.com/external/3iWUoMURXKC-OCgNc/download", is_password_protected: false, modified_by: "Zylker Creation", resource_id: "cjrrr81bad43595d94a5bbbb4ea1589ef9236", created_time_in_millis: 1618299960679, link_name: "notes", modified_time_in_millis: 1618299960679, status: 1 }, relationships: { password: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/relationships/password", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/password" } }, report: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/relationships/report", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/report" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/relationships/timeline", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/timeline" } }, register: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/relationships/register", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/register" } } }, links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc" } } }
Show fullCreate External Share Custom Link
This API creates a new external share link for a file or folder.
Request Body Parameters
resource_idstring | |
link_namestring | |
request_user_databoolean | |
allow_downloadboolean | |
password_textstring | |
input_fieldslist | |
role_idint | Note: |
expiration_datestring | If set any date, the share link will be deactivated after the expiry date.
Note: |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/links
{ data: { attributes: { resource_id: "cjrrr81bad43595d94a5bbbb4ea1589ef9236", link_name: "notes", request_user_data: "true", allow_download: "true", password_text: "yourpassword", input_fields: [ { field_name: "Name", field_type: "TEXT", is_name_field: true } ], role_id: "7", expiration_date: "2021-04-15" }, type: "links" } }
Example Response
{ data: { id: "3iWUoMURXKC-OCgNc", type: "links", attributes: { modified_time_i18: "Apr 13, 1:16 PM", created_time: "Apr 13, 1:16 PM", expiration_date: "Apr 15, 11:59 PM", expiration_date_in_millis: 1618511399000, link: "https://workdrive.zohoexternal.com/external/3iWUoMURXKC-OCgNc", input_fields: [], type: "folder", can_display_profile: false, created_by: "Zylker Creation", use_shorten_link: false, created_time_i18: "Apr 13, 1:16 PM", allow_download: true, request_user_data: false, link_type: "custom", modified_time: "Apr 13, 1:16 PM", is_expired: false, role_id: 34, download_url: "https://workdrive.zohoexternal.com/external/3iWUoMURXKC-OCgNc/download", is_password_protected: true, modified_by: "Zylker Creation", resource_id: "cjrrr81bad43595d94a5bbbb4ea1589ef9236", created_time_in_millis: 1618299960679, link_name: "notes", modified_time_in_millis: 1618299960679, status: 1 }, relationships: { password: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/relationships/password", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/password" } }, report: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/relationships/report", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/report" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/relationships/timeline", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/timeline" } }, register: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/relationships/register", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/register" } } }, links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc" } } }
Show fullCreate External Share Download Link
This API creates download external share links for files and folders stored in a team folder or my folders.
Here, user can set a download limit and expiration for each download link.
Request Body Parameters
resource_idstring | Mandatory The unique ID of the file/folder. |
link_namestring | Mandatory The name of the link to be shared. |
link_typestring | Mandatory Should be "download". |
request_user_databoolean | Mandatory Should be "false". |
allow_downloadboolean | Mandatory Should be "true". |
expiration_datestring | Optional Expiration time of the shared link. By default the link won't expire. This field is optional. Format: "yyyy-mm-dd hh:mm:ss" Note: |
download_linkjson | Optional download_limit - The maximum number of downloads allowed for the link. |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/links
{ data: { attributes: { resource_id: "cjrrr55b395f872ad4b0a8c52b02eab98c1c5", link_name: "report2021", link_type: "download", request_user_data: "false", allow_download: "true", expiration_date: "2021-5-1", download_link: { download_limit: "5" } }, type: "links" } }
Example Response
{ data: { id: "3iWUoMUS63M-OCgNc", type: "links", attributes: { modified_time_i18: "Apr 22, 11:47 AM", link: "https://workdrive.zohoexternal.com/external/3iWUoMUS63M-OCgNc/download", input_fields: [], type: "image", expiration_date: "May 1, 11:59 PM", expiration_date_in_millis: 1619893799000, created_time_i18: "Apr 22, 11:47 AM", request_user_data: false, modified_time: "Apr 22, 11:47 AM", role_id: 35, download_url: "https://workdrive.zohoexternal.com/external/3iWUoMUS63M-OCgNc/download", link_name: "report2021", modified_time_in_millis: 1619072274419, created_time: "Apr 22, 11:47 AM", can_display_profile: false, created_by: "Zylker Creation", use_shorten_link: false, allow_download: true, link_type: "download", download_link: { download_limit: 5 }, is_expired: false, is_password_protected: false, modified_by: "Zylker Creation", resource_id: "cjrrr55b395f872ad4b0a8c52b02eab98c1c5", created_time_in_millis: 1619072274419, status: 1 }, relationships: { password: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMUS63M-OCgNc/relationships/password", related: "https://www.zohoapis.com/workdrive/links/3iWUoMUS63M-OCgNc/password" } }, report: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMUS63M-OCgNc/relationships/report", related: "https://www.zohoapis.com/workdrive/links/3iWUoMUS63M-OCgNc/report" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMUS63M-OCgNc/relationships/timeline", related: "https://www.zohoapis.com/workdrive/links/3iWUoMUS63M-OCgNc/timeline" } }, register: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMUS63M-OCgNc/relationships/register", related: "https://www.zohoapis.com/workdrive/links/3iWUoMUS63M-OCgNc/register" } } }, links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMUS63M-OCgNc" } } }
Show fullChange Download Link Settings
This API helps in updating the download settings for the external share links.
Path Parameters
link_idstring | Mandatory The unique ID of the shared link. |
Request Body Parameters
allow_downloadboolean | Mandatory Should be "true"" or "false"".
|
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/links/{link_id}
{ data: { attributes: { allow_download: "true" }, type: "links" } }
Example Response
{ data: { id: "3iWUoMURXKC-OCgNc", type: "links", attributes: { modified_time_i18: "Apr 14, 2:36 PM", created_time: "Apr 13, 1:16 PM", expiration_date: "Apr 30, 11:59 PM", expiration_date_in_millis: 1718511559000, link: "https://workdrive.zohoexternal.com/external/3iWUoMURXKC-OCgNc", input_fields: [], type: "folder", can_display_profile: false, created_by: "Zylker Creation", use_shorten_link: false, created_time_i18: "Apr 13, 1:16 PM", allow_download: true, request_user_data: false, link_type: "custom", modified_time: "Apr 13, 1:16 PM", is_expired: false, role_id: 34, download_url: "https://workdrive.zohoexternal.com/external/3iWUoMURXKC-OCgNc/download", is_password_protected: true, modified_by: "Zylker Creation", resource_id: "cjrrr81bad43595d94a5bbbb4ea1589ef9236", created_time_in_millis: 1618299960679, link_name: "notes", modified_time_in_millis: 1618299960679, status: 1 }, relationships: { password: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/relationships/password", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/password" } }, report: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/relationships/report", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/report" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/relationships/timeline", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/timeline" } }, register: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/relationships/register", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/register" } } }, links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc" } } }
Show fullChange Expiration Settings
This API helps in changing the expiration date of the link.
Path Parameters
link_idstring | Mandatory The unique ID of the shared link |
Request Body Parameters
expiration_datestring | Mandatory Expiration time of the shared link. By default the link won't expire. This field is optional. format : "yyyy-mm-dd hh:mm:ss". Note: |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/links/{link_id}
{ data: { attributes: { expiration_date: "2021-10-01" }, type: "links" } }
Example Response
{ data: { id: "3iWUoMURXKC-OCgNc", type: "links", attributes: { modified_time_i18: "Apr 14, 2:36 PM", created_time: "Apr 13, 1:16 PM", expiration_date: "Oct 1, 11:59 PM", expiration_date_in_millis: 1718511559000, link: "https://workdrive.zohoexternal.com/external/3iWUoMURXKC-OCgNc", input_fields: [], type: "folder", can_display_profile: false, created_by: "Zylker Creation", use_shorten_link: false, created_time_i18: "Apr 13, 1:16 PM", allow_download: false, request_user_data: false, link_type: "custom", modified_time: "Apr 13, 1:16 PM", is_expired: false, role_id: 34, download_url: "https://workdrive.zohoexternal.com/external/3iWUoMURXKC-OCgNc/download", is_password_protected: true, modified_by: "Zylker Creation", resource_id: "cjrrr81bad43595d94a5bbbb4ea1589ef9236", created_time_in_millis: 1618299960679, link_name: "notes", modified_time_in_millis: 1618299960679, status: 1 }, relationships: { password: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/relationships/password", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/password" } }, report: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/relationships/report", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/report" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/relationships/timeline", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/timeline" } }, register: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/relationships/register", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/register" } } }, links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc" } } }
Show fullChange Password Link Settings
This API helps in changing the password and to enable or disable password protection for the link.
Path Parameters
link_idstring | Mandatory The unique ID of the shared link |
Request Body Parameters
is_password_protectedboolean | Optional Should be "false" to disable password protection for the link. |
password_textstring | Mandatory Password to access the file. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/links/{link_id}
{ data: { attributes: { is_password_protected: "false", password_text: "updatedpassword" }, type: "links" } }
Example Response
{ data: { id: "3iWUoMURXKC-OCgNc", type: "links", attributes: { modified_time_i18: "Apr 14, 2:36 PM", created_time: "Apr 13, 1:16 PM", expiration_date: "Apr 30, 11:59 PM", expiration_date_in_millis: 1718511559000, link: "https://workdrive.zohoexternal.com/external/3iWUoMURXKC-OCgNc", input_fields: [], type: "folder", can_display_profile: false, created_by: "Zylker Creation", use_shorten_link: false, created_time_i18: "Apr 13, 1:16 PM", allow_download: false, request_user_data: false, link_type: "custom", modified_time: "Apr 13, 1:16 PM", is_expired: false, role_id: 34, download_url: "https://workdrive.zohoexternal.com/external/3iWUoMURXKC-OCgNc/download", is_password_protected: false, modified_by: "Zylker Creation", resource_id: "cjrrr81bad43595d94a5bbbb4ea1589ef9236", created_time_in_millis: 1618299960679, link_name: "notes", modified_time_in_millis: 1618299960679, status: 1 }, relationships: { password: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/relationships/password", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/password" } }, report: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/relationships/report", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/report" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/relationships/timeline", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/timeline" } }, register: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/relationships/register", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc/register" } } }, links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKC-OCgNc" } } }
Show fullRevoke External Share Link
This API deletes a file or folder's external share link.
Path Parameters
link_idstring |
Example Request
DELETE https://www.zohoapis.com/workdrive/api/v1/links/{link_id}
Example Response
204: No Content
Comments
WorkDrive allows users to give feedback and exchange ideas on shared documents in real-time. Comments can be made independently or created as replies to other comments.
Get Comment Info
This API fetches all available details of the comment. When a new comment is added to a file, it will create a comment_id for that comment.
Path Parameters
comment_idstring | Mandatory The unique ID of the comment. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/comments/{comment_id}
Example Response
{ data: [ { id: "ly9zm850678101cec4b0698777ab4534a3002-2774428000000002064", type: "comments", attributes: { commented_by: "Zylker Creation", created_time: "Apr 13, 1:24 PM", capabilities: { can_delete_comment: true, can_edit_comment: true, can_replyto_comment: true, can_resolve_comment: true }, commented_email_id: "zylker@zylker.com", modified_email_id: "zylker@zylker.com", comment_html: "Fine", version: "1.0", modified_time: "Apr 13, 1:24 PM", children: [ { data: { id: "ly9zm850678101cec4b0698777ab4534a3002-2774428000000002064", type: "comments", attributes: { commented_by: "Zylker Creation", created_time: "Apr 13, 1:24 PM", capabilities: { can_delete_comment: true, can_edit_comment: true, can_replyto_comment: true, can_resolve_comment: true }, commented_email_id: "zylker@zylker.com", modified_email_id: "zylker@zylker.com", comment_html: "Fine", version: "1.0", modified_time: "Apr 13, 1:24 PM", commented_by_zuid: 747938014, modified_by_zuid: 747938014, modified_by: "Zylker Creation", contacts_url: "https://contacts.zoho.com/file?t=user&ID=747938014&fs=thumb", resource_id: "ly9zm850678101cec4b0698777ab4534a3002", created_time_in_millis: 1618300488998, modified_time_in_millis: 1618300488998, parent_comment_id: "ly9zm850678101cec4b0698777ab4534a3002-2774428000000002063", top_version: true, resolved: false }, links: { self: "https://www.zohoapis.com/workdrive/comments/ly9zm850678101cec4b0698777ab4534a3002-2774428000000002064" } } } ], commented_by_zuid: 747938014, modified_by_zuid: 747938014, modified_by: "Zylker Creation", contacts_url: "https://contacts.zoho.com/file?t=user&ID=747938014&fs=thumb", resource_id: "ly9zm850678101cec4b0698777ab4534a3002", created_time_in_millis: 1618300488998, modified_time_in_millis: 1618300488998, top_version: true, resolved: false }, links: { self: "https://www.zohoapis.com/workdrive/comments/ly9zm850678101cec4b0698777ab4534a3002-2774428000000002064" } } ] }
Show fullCreate Comment
This API adds comments within a file.
Request Body Parameters
resource_idstring | Mandatory The unique ID of the file. |
comment_htmlstring | Mandatory The comment to be added within the file. |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/comments
{ data: { attributes: { resource_id: "ly9zm850678101cec4b0698777ab4534a3002", comment_html: "Fine" }, type: "comments" } }
Example Response
{ data: { id: "ly9zm850678101cec4b0698777ab4534a3002-2774428000000002064", type: "comments", attributes: { commented_by: "Zylker Creation", created_time: "Apr 13, 1:24 PM", capabilities: { can_delete_comment: true, can_edit_comment: true, can_replyto_comment: true, can_resolve_comment: true }, commented_email_id: "zylker@zylker.com", modified_email_id: "zylker@zylker.com", comment_html: "Fine", version: "1.0", modified_time: "Apr 13, 1:24 PM", commented_by_zuid: 747938014, modified_by_zuid: 747938014, modified_by: "Zylker Creation", contacts_url: "https://contacts.zoho.com/file?t=user&ID=747938014&fs=thumb", resource_id: "ly9zm850678101cec4b0698777ab4534a3002", created_time_in_millis: 1618300488998, modified_time_in_millis: 1618300488998, top_version: true, resolved: false }, links: { self: "https://www.zohoapis.com/workdrive/comments/ly9zm850678101cec4b0698777ab4534a3002-2774428000000002064" } } }
Show fullCreate Reply
This API adds a reply to an existing comment on a file.
Request Body Parameters
resource_idstring | Mandatory The unique ID of the file. |
comment_htmlstring | Mandatory The comment to be added within the file. |
parent_comment_idstring | Mandatory The unique ID of the comment to which the reply needs to be added. |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/comments
{ data: { attributes: { resource_id: "ly9zm850678101cec4b0698777ab4534a3002", comment_html: "Fine", parent_comment_id: "ly9zm850678101cec4b0698777ab4534a3002-2774428000000002063" }, type: "comments" } }
Example Response
{ data: { id: "ly9zm850678101cec4b0698777ab4534a3002-2774428000000002064", type: "comments", attributes: { commented_by: "Zylker Creation", created_time: "Apr 13, 1:24 PM", capabilities: { can_delete_comment: true, can_edit_comment: true, can_replyto_comment: true, can_resolve_comment: true }, commented_email_id: "zylker@zylker.com", modified_email_id: "zylker@zylker.com", comment_html: "Fine", version: "1.0", modified_time: "Apr 13, 1:24 PM", commented_by_zuid: 747938014, modified_by_zuid: 747938014, modified_by: "Zylker Creation", contacts_url: "https://contacts.zoho.com/file?t=user&ID=747938014&fs=thumb", resource_id: "ly9zm850678101cec4b0698777ab4534a3002", created_time_in_millis: 1618300488998, modified_time_in_millis: 1618300488998, parent_comment_id: "ly9zm850678101cec4b0698777ab4534a3002-2774428000000002063", top_version: true, resolved: false }, links: { self: "https://www.zohoapis.com/workdrive/comments/ly9zm850678101cec4b0698777ab4534a3002-2774428000000002064" } } }
Show fullResolve Comment
This API resolves a specific comment.
Only parent comments can be resolved/reopened
Path Parameters
comment_idstring | Mandatory The unique ID of the comment. |
Request Body Parameters
resolvedboolean | Mandatory Set to "true" to resolve the comment. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/comments/{comment_id}
{ data: { attributes: { resolved: "true" }, type: "comments" } }
Example Response
{ data: { id: "ly9zm850678101cec4b0698777ab4534a3002-2774428000000002064", type: "comments", attributes: { commented_by: "Zylker Creation", created_time: "Apr 13, 1:24 PM", capabilities: { can_delete_comment: true, can_edit_comment: true, can_replyto_comment: true, can_resolve_comment: true }, commented_email_id: "zylker@zylker.com", modified_email_id: "zylker@zylker.com", comment_html: "Fine", version: "1.0", modified_time: "Apr 13, 1:24 PM", commented_by_zuid: 747938014, modified_by_zuid: 747938014, modified_by: "Zylker Creation", contacts_url: "https://contacts.zoho.com/file?t=user&ID=747938014&fs=thumb", resource_id: "ly9zm850678101cec4b0698777ab4534a3002", created_time_in_millis: 1618300488998, modified_time_in_millis: 1618300488998, top_version: true, resolved: true }, links: { self: "https://www.zohoapis.com/workdrive/comments/ly9zm850678101cec4b0698777ab4534a3002-2774428000000002064" } } }
Show fullReopen Comment
This API reopens a specific comment.
Only parent comments can be resolved/reopened
Path Parameters
comment_idstring | Mandatory The unique ID of the comment. |
Request Body Parameters
resolvedboolean | Mandatory Set to "false" to reopen the comment. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/comments/{comment_id}
{ data: { attributes: { resolved: "false" }, type: "comments" } }
Example Response
{ data: { id: "ly9zm850678101cec4b0698777ab4534a3002-2774428000000002064", type: "comments", attributes: { commented_by: "Zylker Creation", created_time: "Apr 13, 1:24 PM", capabilities: { can_delete_comment: true, can_edit_comment: true, can_replyto_comment: true, can_resolve_comment: true }, commented_email_id: "zylker@zylker.com", modified_email_id: "zylker@zylker.com", comment_html: "Fine", version: "1.0", modified_time: "Apr 13, 1:24 PM", commented_by_zuid: 747938014, modified_by_zuid: 747938014, modified_by: "Zylker Creation", contacts_url: "https://contacts.zoho.com/file?t=user&ID=747938014&fs=thumb", resource_id: "ly9zm850678101cec4b0698777ab4534a3002", created_time_in_millis: 1618300488998, modified_time_in_millis: 1618300488998, top_version: true, resolved: false }, links: { self: "https://www.zohoapis.com/workdrive/comments/ly9zm850678101cec4b0698777ab4534a3002-2774428000000002064" } } }
Show fullEdit Comment
This API updates a specific comment.
Path Parameters
comment_idstring | Mandatory The unique ID of the comment. |
Request Body Parameters
comment_htmlstring | Mandatory The comment to be added within the file. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/comments/{comment_id}
{ data: { attributes: { comment_html: "Fine" }, type: "comments" } }
Example Response
{ data: { id: "ly9zm850678101cec4b0698777ab4534a3002-2774428000000002064", type: "comments", attributes: { commented_by: "Zylker Creation", created_time: "Apr 13, 1:24 PM", capabilities: { can_delete_comment: true, can_edit_comment: true, can_replyto_comment: true, can_resolve_comment: true }, commented_email_id: "zylker@zylker.com", modified_email_id: "zylker@zylker.com", comment_html: "Fine", version: "1.0", modified_time: "Apr 13, 1:24 PM", commented_by_zuid: 747938014, modified_by_zuid: 747938014, modified_by: "Zylker Creation", contacts_url: "https://contacts.zoho.com/file?t=user&ID=747938014&fs=thumb", resource_id: "ly9zm850678101cec4b0698777ab4534a3002", created_time_in_millis: 1618300488998, modified_time_in_millis: 1618300488998, top_version: true, resolved: true, edited: true }, links: { self: "https://www.zohoapis.com/workdrive/comments/ly9zm850678101cec4b0698777ab4534a3002-2774428000000002064" } } }
Show fullDelete Comment
This API deletes a specific comment.
Path Parameters
comment_idstring | Mandatory The unique ID of the comment. |
Example Request
DELETE https://www.zohoapis.com/workdrive/api/v1/comments/{comment_id}
Example Response
204: No Content
Team Member Files
WorkDrive presents a list of shortcut menus for user's easy access to their data. One can find them in the top-left sidebar of WorkDrive's user panel.
Get Files in Shared with Me
This API fetches the list of files shared to the member by other team members in a team.
The Shared with me tab displays all files that are shared with the user by other team members.
Path Parameters
team_member_idstring |
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
filter[type]string | To filter by resource type. Eg. filter[type]=allfiles For list of filter type, see File filter in Filters page. Refer here |
filter[user]string | |
filter[group]string | |
page[limit]string | For More Details about pagination. Refer here |
page[offset]string | |
sortstring | Sorting can be done with these fields:
|
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/users/{team_member_id}/incomingfiles?page%5Blimit%5D=50&page%5Boffset%5D=0
Example Response
{ data: [ { id: "ly9zm2a10ffa33a464feaa665da051690be89", type: "files", attributes: { modified_by_zuid: "747938058", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, collab_id: "2243228333862236863", storage_info: { size: "92.0 KB", storage_used: "92.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 94427, storage_used_in_bytes: 94427 }, type: "image", created_time_i18: "Apr 12, 11:25 PM", associated_data_templates: [], modified_time_in_millisecond: 1618250118149, opened_time: "Apr 12, 11:25 PM", status_change_time: "Apr 12, 11:25 PM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/ly9zm2a10ffa33a464feaa665da051690be89", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 12, 11:25 PM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "Market Analysis.png", created_by: "Zylker Creation", display_html_name: "Market Analysis.png", labels: [], name: "Market Analysis.png", status_change_time_in_millisecond: 1618250118149, permalink: "https://www.zohoapis.com/workdrive/file/ly9zm2a10ffa33a464feaa665da051690be89", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Apr 12, 11:25 PM", opened_time_i18: "Apr 12, 11:25 PM", extn: "png", shortcut_link: "", status_change_time_i18: "Apr 12, 11:25 PM", description: "", uploaded_time_in_millisecond: 1618250103369, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm2a10ffa33a464feaa665da051690be89", title: "", modified_time: "Apr 12, 11:25 PM", icon_class: "img", created_time_in_millisecond: 1618250103366, owner: "747937818", creator: "747938058", capabilities: { can_read: true, can_share: false, can_remove_share: true, can_delete: false, can_edit: false, can_upload_files: false, can_trash: false, can_rename: false, can_restore: false, can_copy: true, can_move: false, can_zip: true, can_download: true, can_emailattach: true, can_publish: false, can_create_task: true, can_share_support: false, can_label: true, can_delist_file: true, can_checkout: false, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: true, can_trash_files: false }, uploaded_time_i18: "Apr 12, 11:25 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618250103366, edit_badge_count: 0, share_data: [ { shared_by: "Zylker Creation", shared_time: "Apr 12, 11:25 PM", shared_time_i18: "Apr 12, 11:25 PM", shared_time_in_millis: 1618250127877, shared_to: "747938014" } ], uploaded_time: "Apr 12, 11:25 PM", has_folders: false, service_type: "upload", display_url_name: "Market+Analysis.png", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm2a10ffa33a464feaa665da051690be89" } } ] }
Show fullGet Folders in Shared with Me
This API fetches the list of folders shared to the members by other team members in a team.
Path Parameters
team_member_idstring |
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
page[limit]string | For More Details about pagination. Refer here |
page[offset]string |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/users/{team_member_id}/incomingfolders?page%5Blimit%5D=50&page%5Boffset%5D=0
Example Response
{ data: [ { id: "cjrrr81bad43595d94a5bbbb4ea1589ef9236", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 0, is_fillable_resource: false, is_published: false, destination_id: "ly9zme5724e019a8e4cb48632945b1296be0a", storage_info: { files_count: 0, folders_count: 0, size_in_bytes: 0, storage_used_in_bytes: 0 }, type: "folder", created_time_i18: "Apr 13, 12:25 PM", modified_time_in_millisecond: 1618296919142, opened_time: "Apr 13, 12:25 PM", status_change_time: "Apr 13, 12:25 PM", download_url: "https://www.zohoapis.com/workdrive/download/cjrrr81bad43595d94a5bbbb4ea1589ef9236", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 13, 12:25 PM", lock_status: 2, is_folder: true, resource_type: 1001, is_email_in_upload: false, display_attr_name: "Notes", created_by: "Zylker Creation", display_html_name: "Notes", labels: [], parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a", name: "Notes", status_change_time_in_millisecond: 1618296919142, permalink: "https://www.zohoapis.com/workdrive/folder/cjrrr81bad43595d94a5bbbb4ea1589ef9236", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Apr 13, 12:25 PM", opened_time_i18: "Apr 13, 12:25 PM", extn: "", view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, shortcut_link: "", status_change_time_i18: "Apr 13, 12:25 PM", description: "", uploaded_time_in_millisecond: 1618296919146, thumbnail_url: "", title: "", files_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, modified_time: "Apr 13, 12:25 PM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "folder", created_time_in_millisecond: 1618296919142, 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, 12:25 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618296919142, edit_badge_count: 0, share_data: [ { shared_by: "Zylker Creation", shared_time: "Apr 13, 12:49 PM", shared_time_i18: "Apr 13, 12:49 PM", shared_time_in_millis: 1618298370952, shared_to: "747938058" } ], uploaded_time: "Apr 13, 12:25 PM", has_folders: false, service_type: "upload", display_url_name: "Notes", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/files", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/links", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236" } } ] }
Show fullGet Recent Files
This API fetches files and folders recently used by this team member.
The Recent files tab on the WorkDrive homepage displays all the files the user worked on recently.
The team_member_id is created when a user becomes part of a team.
Path Parameters
team_member_idstring | Mandatory 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[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 |
page[limit]string | Optional Limit indicates the number of items to be listed. For More Details about pagination. Refer here |
page[offset]string | Optional Offset indicates from where the listing should start. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/users/{team_member_id}/recentfiles?page%5Blimit%5D=50&page%5Boffset%5D=0
Example Response
{ data: [ { id: "cjrrr55b395f872ad4b0a8c52b02eab98c1c5", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, destination_id: "cjrrr81bad43595d94a5bbbb4ea1589ef9236", storage_info: { size: "90.0 KB", storage_used: "165.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 92684, storage_used_in_bytes: 169541 }, type: "image", created_time_i18: "Apr 13, 3:03 PM", associated_data_templates: [], modified_time_in_millisecond: 1618306634449, opened_time: "Apr 13, 3:03 PM", status_change_time: "Apr 13, 3:07 PM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/cjrrr55b395f872ad4b0a8c52b02eab98c1c5", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 13, 3:03 PM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "Capture.JPG", user_access_time: "Apr 13, 3:07 PM", created_by: "Zylker Creation", display_html_name: "Capture.JPG", labels: [], user_access_time_i18: "Apr 13, 3:07 PM", parent_id: "cjrrr81bad43595d94a5bbbb4ea1589ef9236", name: "Capture.JPG", status_change_time_in_millisecond: 1618306634449, permalink: "https://www.zohoapis.com/workdrive/file/cjrrr55b395f872ad4b0a8c52b02eab98c1c5", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Apr 13, 3:07 PM", opened_time_i18: "Apr 13, 3:03 PM", extn: "jpg", user_access_time_in_millis: 1618306634449, shortcut_link: "", status_change_time_i18: "Apr 13, 3:07 PM", description: "", uploaded_time_in_millisecond: 1618306387232, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/cjrrr55b395f872ad4b0a8c52b02eab98c1c5", title: "", modified_time: "Apr 13, 3:07 PM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "img", created_time_in_millisecond: 1618306387229, owner: "747937818", creator: "747938014", uploaded_time_i18: "Apr 13, 3:03 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618306387229, edit_badge_count: 0, share_data: [], uploaded_time: "Apr 13, 3:03 PM", has_folders: false, service_type: "upload", recent_action: "last_modified_time", display_url_name: "Capture.JPG", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/files", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/links", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5" } } ] }
Show fullGet Favorited Files
This API fetches files and folders that are marked as favorite by this team member.
Users can add their frequently used or important files and folders to favorites for easy access. The team_member_id is created when a user becomes part of a team.
Path Parameters
team_member_idstring | Mandatory 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[type]string | Optional To filter by resource type. Eg. filter[type]=documents For list of filter type, see file filter in Filters page. Refer here |
page[limit]string | Optional Limit indicates the number of items to be listed. For More Details about pagination. Refer here |
page[offset]string | Optional Offset indicates from where the listing should start. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/users/{team_member_id}/favoritedfiles?page%5Blimit%5D=50&page%5Boffset%5D=0
Example Response
{ data: [ { id: "cjrrr55b395f872ad4b0a8c52b02eab98c1c5", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, destination_id: "cjrrr81bad43595d94a5bbbb4ea1589ef9236", storage_info: { size: "90.0 KB", storage_used: "165.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 92684, storage_used_in_bytes: 169541 }, type: "image", created_time_i18: "Apr 13, 3:03 PM", modified_time_in_millisecond: 1618306634449, opened_time: "Apr 13, 3:03 PM", status_change_time: "Apr 13, 3:07 PM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/cjrrr55b395f872ad4b0a8c52b02eab98c1c5", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 13, 3:03 PM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "Capture.JPG", created_by: "Zylker Creation", display_html_name: "Capture.JPG", labels: [], parent_id: "cjrrr81bad43595d94a5bbbb4ea1589ef9236", name: "Capture.JPG", status_change_time_in_millisecond: 1618306634449, permalink: "https://www.zohoapis.com/workdrive/file/cjrrr55b395f872ad4b0a8c52b02eab98c1c5", favorite: true, new_badge_count: 0, status: 1, modified_time_i18: "Apr 13, 3:07 PM", opened_time_i18: "Apr 13, 3:03 PM", extn: "jpg", shortcut_link: "", status_change_time_i18: "Apr 13, 3:07 PM", description: "", uploaded_time_in_millisecond: 1618306387232, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/cjrrr55b395f872ad4b0a8c52b02eab98c1c5", title: "", modified_time: "Apr 13, 3:07 PM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "img", created_time_in_millisecond: 1618306387229, owner: "747937818", creator: "747938014", uploaded_time_i18: "Apr 13, 3:03 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618306387229, edit_badge_count: 0, share_data: [], uploaded_time: "Apr 13, 3:03 PM", has_folders: false, service_type: "upload", display_url_name: "Capture.JPG", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/files", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/links", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr55b395f872ad4b0a8c52b02eab98c1c5" } } ] }
Show fullGet Labeled Files
This API fetches all files and folders associated with a label.
Path Parameters
team_member_idstring | Mandatory The unique ID of the team member that is created when a member is added into a team. |
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 particular label |
filter[type]string | Optional To filter by resource type. Eg. filter[type]=documents For list of filter type, see file filter in Filters page. Refer here |
page[limit]string | Optional Limit indicates the number of items to be listed. 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:
|
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/users/{team_member_id}/labeledfiles?page%5Blimit%5D=50&page%5Boffset%5D=0
Example Response
{ 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.localzoho.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.localzoho.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" } } ] }
Show fullMy Folders Files
WorkDrive presents a list of shortcut menus for user's easy access to their data. One can find them in the top-left sidebar of WorkDrive's user panel.
Get My Folders Id
This API fetches the ID of the team member's my folders.
The team_member_id is created when a user becomes part of a team.
Path Parameters
team_member_idstring | Mandatory The unique ID that represents the team member. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/users/{team_member_id}/privatespace
Example Response
{ data: [ { id: "ly9zme5724e019a8e4cb48632945b1296be0a", type: "privatespace", attributes: { trashedfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, outgoingfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, incomingfiles_view_pref: { sort_by: "shared_time", sort_order: "desc", filtered_by: "all", layout: "list" }, view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, is_unread_myspace: false, unread_count_myspace: 0, files_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" } }, relationships: { settings: { links: { self: "https://www.zohoapis.com/workdrive/privatespace/ly9zme5724e019a8e4cb48632945b1296be0a/relationships/settings", related: "https://www.zohoapis.com/workdrive/privatespace/ly9zme5724e019a8e4cb48632945b1296be0a/settings" } }, folders: { links: { self: "https://www.zohoapis.com/workdrive/privatespace/ly9zme5724e019a8e4cb48632945b1296be0a/relationships/folders", related: "https://www.zohoapis.com/workdrive/privatespace/ly9zme5724e019a8e4cb48632945b1296be0a/folders" } }, deletedfiles: { links: { self: "https://www.zohoapis.com/workdrive/privatespace/ly9zme5724e019a8e4cb48632945b1296be0a/relationships/deletedfiles", related: "https://www.zohoapis.com/workdrive/privatespace/ly9zme5724e019a8e4cb48632945b1296be0a/deletedfiles" } }, incomingfiles: { links: { self: "https://www.zohoapis.com/workdrive/privatespace/ly9zme5724e019a8e4cb48632945b1296be0a/relationships/incomingfiles", related: "https://www.zohoapis.com/workdrive/privatespace/ly9zme5724e019a8e4cb48632945b1296be0a/incomingfiles" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/privatespace/ly9zme5724e019a8e4cb48632945b1296be0a/relationships/files", related: "https://www.zohoapis.com/workdrive/privatespace/ly9zme5724e019a8e4cb48632945b1296be0a/files" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/privatespace/ly9zme5724e019a8e4cb48632945b1296be0a/relationships/links", related: "https://www.zohoapis.com/workdrive/privatespace/ly9zme5724e019a8e4cb48632945b1296be0a/links" } }, trashedfiles: { links: { self: "https://www.zohoapis.com/workdrive/privatespace/ly9zme5724e019a8e4cb48632945b1296be0a/relationships/trashedfiles", related: "https://www.zohoapis.com/workdrive/privatespace/ly9zme5724e019a8e4cb48632945b1296be0a/trashedfiles" } }, incomingfolders: { links: { self: "https://www.zohoapis.com/workdrive/privatespace/ly9zme5724e019a8e4cb48632945b1296be0a/relationships/incomingfolders", related: "https://www.zohoapis.com/workdrive/privatespace/ly9zme5724e019a8e4cb48632945b1296be0a/incomingfolders" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/privatespace/ly9zme5724e019a8e4cb48632945b1296be0a/relationships/copy", related: "https://www.zohoapis.com/workdrive/privatespace/ly9zme5724e019a8e4cb48632945b1296be0a/copy" } }, outgoingfiles: { links: { self: "https://www.zohoapis.com/workdrive/privatespace/ly9zme5724e019a8e4cb48632945b1296be0a/relationships/outgoingfiles", related: "https://www.zohoapis.com/workdrive/privatespace/ly9zme5724e019a8e4cb48632945b1296be0a/outgoingfiles" } } }, links: { self: "https://www.zohoapis.com/workdrive/privatespace/ly9zme5724e019a8e4cb48632945b1296be0a" } } ] }
Show fullGet My Folders Links
This API fetches the list of the external share links created for the files/folders inside the team member's my folders.
My Folders is an exclusive space, where a user can create, upload, and share his/her own files.
myfolder_id is created when a user is added to a WorkDrive team.
Path Parameters
myfolder_idstring | Mandatory The unique ID that represents team member's my folders. |
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 link type. Eg. filter[type]=download For list of filter type, see Link filter in Filters page. Refer here |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/privatespace/{myfolder_id}/links
Example Response
{ data: [ { id: "3iWUoMURXKD-OCgNc", type: "links", attributes: { modified_time_i18: "Apr 13, 1:20 PM", link: "https://workdrive.zohoexternal.com/external/3iWUoMURXKD-OCgNc", resource_extension: "jpg", input_fields: [], type: "image", created_time_i18: "Apr 13, 1:20 PM", request_user_data: false, modified_time: "Apr 13, 1:20 PM", role_id: 34, download_url: "https://workdrive.zohoexternal.com/external/3iWUoMURXKD-OCgNc/download", link_name: "test", modified_time_in_millis: 1618300233274, resource_status: 1, created_time: "Apr 13, 1:20 PM", file_name: "Capture.JPG", can_display_profile: false, created_by: "Zylker Creation", use_shorten_link: false, allow_download: true, link_type: "custom", is_expired: false, is_password_protected: false, modified_by: "Zylker Creation", resource_id: "ly9zm850678101cec4b0698777ab4534a3002", created_time_in_millis: 1618300233274, status: 1 }, relationships: { password: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKD-OCgNc/relationships/password", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKD-OCgNc/password" } }, report: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKD-OCgNc/relationships/report", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKD-OCgNc/report" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKD-OCgNc/relationships/timeline", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKD-OCgNc/timeline" } }, register: { links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKD-OCgNc/relationships/register", related: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKD-OCgNc/register" } } }, links: { self: "https://www.zohoapis.com/workdrive/links/3iWUoMURXKD-OCgNc" } } ] }
Show fullGet Files in My Folders
This API fetches files from the team member's my folders.
myfolder_id is created when an user is added to a WorkDrive team.
Path Parameters
myfolder_idstring | Mandatory The unique ID of the team member's my folders. |
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]=documents For list of filter type, see File filter in Filters page. Refer here |
filter[extension]string | Optional Filter resources by their file extensions |
page[limit]string | Optional Limit indicates the number of items to be listed. 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. |
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. |
fields[files]string | Optional Mention the required params to be included in the response attribute. |
sortstring | Optional Sorting can be done with these fields:
|
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/privatespace/{myfolder_id}/files?page%5Blimit%5D=50&page%5Boffset%5D=0
Example Response
{ data: [ { id: "cjrrr81bad43595d94a5bbbb4ea1589ef9236", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 0, is_fillable_resource: false, is_published: false, destination_id: "ly9zme5724e019a8e4cb48632945b1296be0a", storage_info: { size: "181.0 KB", storage_used: "256.0 KB", files_count: 2, folders_count: 0, size_in_bytes: 185368, storage_used_in_bytes: 262225 }, type: "folder", created_time_i18: "Apr 13, 12:25 PM", modified_time_in_millisecond: 1618296919142, opened_time: "Apr 13, 12:25 PM", status_change_time: "Apr 13, 12:25 PM", download_url: "https://www.zohoapis.com/workdrive/download/cjrrr81bad43595d94a5bbbb4ea1589ef9236", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 13, 12:25 PM", lock_status: 2, is_folder: true, resource_type: 1001, is_email_in_upload: false, display_attr_name: "Notes", created_by: "Zylker Creation", display_html_name: "Notes", labels: [], parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a", name: "Notes", status_change_time_in_millisecond: 1618296919142, permalink: "https://www.zohoapis.com/workdrive/folder/cjrrr81bad43595d94a5bbbb4ea1589ef9236", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Apr 13, 12:25 PM", opened_time_i18: "Apr 13, 12:25 PM", extn: "", view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, shortcut_link: "", status_change_time_i18: "Apr 13, 12:25 PM", description: "", uploaded_time_in_millisecond: 1618296919146, thumbnail_url: "", title: "", files_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, modified_time: "Apr 13, 12:25 PM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "folder", created_time_in_millisecond: 1618296919142, 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, 12:25 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618296919142, edit_badge_count: 0, share_data: [], uploaded_time: "Apr 13, 12:25 PM", has_folders: false, service_type: "upload", display_url_name: "Notes", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/files", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/links", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236" } } ], links: { cursor: { has_next: true, next: "https://www.zohoapis.com/workdrive/api/v1/files/vliy1b942de68431c4b92994025adf85d53fa/files?page[next]=dd1c097d208ec12c5093e359d5859fcce97ddbab18389052caa7d6ed2d6d37b073a8e94e651cfaf15c9c28d46b91b173663e37138b530a40854f2e27a31c" } } }
Show fullGet Folders in My Folders
This API fetches the list of folders inside the team member's my folders.
Path Parameters
myfolder_idstring | Mandatory The unique ID of the team member's my folders. |
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
page[limit]string | Optional Limit indicates the number of items to be listed. 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:
|
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/privatespace/{myfolder_id}/folders?page%5Blimit%5D=50&page%5Boffset%5D=0
Example Response
{ data: [ { id: "cjrrr81bad43595d94a5bbbb4ea1589ef9236", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 0, is_fillable_resource: false, is_published: false, destination_id: "ly9zme5724e019a8e4cb48632945b1296be0a", storage_info: { size: "181.0 KB", storage_used: "256.0 KB", files_count: 2, folders_count: 0, size_in_bytes: 185368, storage_used_in_bytes: 262225 }, type: "folder", created_time_i18: "Apr 13, 12:25 PM", modified_time_in_millisecond: 1618296919142, opened_time: "Apr 13, 12:25 PM", status_change_time: "Apr 13, 12:25 PM", download_url: "https://www.zohoapis.com/workdrive/download/cjrrr81bad43595d94a5bbbb4ea1589ef9236", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 13, 12:25 PM", lock_status: 2, is_folder: true, resource_type: 1001, is_email_in_upload: false, display_attr_name: "Notes", created_by: "Zylker Creation", display_html_name: "Notes", labels: [], parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a", name: "Notes", status_change_time_in_millisecond: 1618296919142, permalink: "https://www.zohoapis.com/workdrive/folder/cjrrr81bad43595d94a5bbbb4ea1589ef9236", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Apr 13, 12:25 PM", opened_time_i18: "Apr 13, 12:25 PM", extn: "", view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, shortcut_link: "", status_change_time_i18: "Apr 13, 12:25 PM", description: "", uploaded_time_in_millisecond: 1618296919146, thumbnail_url: "", title: "", files_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, modified_time: "Apr 13, 12:25 PM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "folder", created_time_in_millisecond: 1618296919142, 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, 12:25 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618296919142, edit_badge_count: 0, share_data: [], uploaded_time: "Apr 13, 12:25 PM", has_folders: false, service_type: "upload", display_url_name: "Notes", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/files", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/links", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/cjrrr81bad43595d94a5bbbb4ea1589ef9236" } } ] }
Show fullGet Trashed Files in My Folders
This API fetches files from the trash folder in the team member's my folders.
The deleted files and folders in my folders will move into the trash folder. One can restore the trashed files from the trash if team member needs them back.
Path Parameters
myfolder_idstring | Mandatory The unique ID of the team member's my folders. |
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
page[limit]string | Optional Limit indicates the number of items to be listed. 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
|
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/privatespace/{myfolder_id}/trashedfiles?page%5Blimit%5D=50&page%5Boffset%5D=0
Example Response
{ data: [ { id: "ly9zm850678101cec4b0698777ab4534a3002", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, destination_id: "ly9zme5724e019a8e4cb48632945b1296be0a", storage_info: { size: "90.0 KB", storage_used: "90.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 92684, storage_used_in_bytes: 92684 }, type: "image", created_time_i18: "Apr 12, 9:45 PM", modified_time_in_millisecond: 1618308007051, opened_time: "Apr 12, 9:45 PM", status_change_time: "Apr 13, 3:30 PM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/ly9zm850678101cec4b0698777ab4534a3002", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 12, 9:45 PM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "Capture.JPG", created_by: "Zylker Creation", display_html_name: "Capture.JPG", labels: [], parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a", name: "Capture.JPG", status_change_time_in_millisecond: 1618308007051, permalink: "https://www.zohoapis.com/workdrive/file/ly9zm850678101cec4b0698777ab4534a3002", favorite: false, new_badge_count: 0, status: 51, modified_time_i18: "Apr 13, 3:30 PM", opened_time_i18: "Apr 12, 9:45 PM", extn: "jpg", shortcut_link: "", status_change_time_i18: "Apr 13, 3:30 PM", description: "", uploaded_time_in_millisecond: 1618244123054, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm850678101cec4b0698777ab4534a3002", title: "", modified_time: "Apr 13, 3:30 PM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "img", created_time_in_millisecond: 1618244123051, owner: "747937818", creator: "747938014", capabilities: { can_read: false, can_share: false, can_remove_share: false, can_delete: true, can_edit: false, can_upload_files: false, can_trash: false, can_rename: false, can_restore: true, can_copy: false, can_move: false, can_zip: false, can_download: false, can_emailattach: false, can_publish: false, can_create_task: false, can_share_support: false, can_label: true, can_checkout: false, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: false, can_create_comment: false, can_trash_files: false }, uploaded_time_i18: "Apr 12, 9:45 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1618244123051, edit_badge_count: 0, share_data: [], uploaded_time: "Apr 12, 9:45 PM", has_folders: false, service_type: "upload", display_url_name: "Capture.JPG", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm850678101cec4b0698777ab4534a3002" } } ] }
Show fullEmpty My Folders Trash
This API will delete the files and folders present in the trash in the team member's my folders.
Request Body Parameters
idstring | Mandatory Set as "emptytrash". |
parent_idstring | Mandatory The unique ID of the team member's my folders. |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/actions
{ data: { attributes: { parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a" }, id: "emptytrash", type: "actions" } }
Example Response
{ data: { id: "emptytrash", type: "actions", attributes: { parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a" }, links: { self: "https://www.zohoapis.com/workdrive/actions/emptytrash" } } }
Enable Document Conversion
This API will help automatically convert all files to Zoho WorkDrive's format while uploading to the user's my folders.
Path Parameters
myfolder_idstring | Mandatory The unique ID of the team member's my folders. |
Request Body Parameters
is_document_conversionboolean | Mandatory Setting this as "true" or "false" will enable or disable automatic conversion of all files to Zoho WorkDrive's format while uploading to the user's my folders. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/settings/{myfolder_id}
{ data: { attributes: { is_document_conversion: "true" }, type: "settings" } }
Example Response
{ data: { id: "ly9zm0170fb40015f4e2297a144e2b68cfa68", type: "settings", attributes: { allow_external_sharing: true, data_template_setting: {}, create_file_as_draft: true, allow_ws_to_change_conversion: true, allow_my_folder_to_change_conversion: false, allow_create_ws: 0, email_in: { is_enabled: false, receive_external_mail: false }, is_external_share_enabled: true, enable_org_logo: false, is_document_conversion: true, can_viewer_download: true, setting_id: "ly9zm0170fb40015f4e2297a144e2b68cfa68" }, links: { self: "https://www.zohoapis.com/workdrive/settings/ly9zm0170fb40015f4e2297a144e2b68cfa68" } } }
Show fullCollect Files
With WorkDrive, the users can create collection links to request any number of users to upload files easily.
Users can create separate collection links for internal (team users) and external users (anyone on the internet) with custom link settings, such as expiration date, file count limit, and file size limit.
Get Collection Info
This API fetches information about a collection.
Path Parameters
collection_idstring | Mandatory A unique ID that represents a collection. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/collections/{collection_id}
Example Response
{ data: { id: "vx57jc433ffa2c7524c51a5205d1849bc92fa", type: "collections", attributes: { modified_time_i18: "May 9, 5:42 PM", modifier_name: "Anna Baker", link: "https://www.zohoapis.com/workdrive/collection/vx57jc433ffa2c7524c51a5205d1849bc92fa", input_fields: [], each_user_each_folder: true, each_user_each_folder_fields: [ "name" ], expiration_date: "May 20, 2021, 11:45 AM", expiration_date_in_millis: 1621491300000, created_time_i18: "Aug 9, 5:42 PM", request_user_data: false, total_uploads: 11, modified_time: "May 9, 5:42 PM", modified_time_in_millis: 1620562320000, total_submissions: 23, upload_file_size_limit_in_bytes: 10485760, created_time: "May 9, 5:42 PM", notify_every_submissions: true, upload_file_size_limit: "10 MB", set_upload_limit: false, override_name_exist: false, is_external: false, personal_note: "Analysis potential leads and assign them to the Sales team", is_expired: false, upload_limit_per_user: 0, parent_id: "vx57jc433ffa2c7524c51a5205d1849bc92fa", created_time_in_millis: 1620562320000, creator_name: "Anna Baker", space_id: "15532088", collection_name: "Event Leads", uploader_note: "Share all leads that you have collected in the recent Dubai Trade Fair", status: 1 }, relationships: { submissions: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/collections/7lse92d3ced8a860d4efca7ba1648f7e3f69d/relationships/submissions", related: "https://www.zohoapis.com/workdrive/api/v1/collections/7lse92d3ced8a860d4efca7ba1648f7e3f69d/submissions" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/collections/7lse92d3ced8a860d4efca7ba1648f7e3f69d" } } }
Show fullGet list of all Submissions
This API fetches all data submissions made through a collection link.
Path Parameters
collection_idstring | Mandatory A unique ID that represents a collection. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/collections/{collection_id}/submissions?page%5Blimit%5D=200&page%5Boffset%5D=0
Example Response
{ data: [ { id: "vx57jc433ffa2c7524c51a5205d1849bc92fa-$2356222981689442465", type: "submissions", attributes: { collection_id: "vx57jc433ffa2c7524c51a5205d1849bc92fa", recent_upload_time: "May 11 23, 9:32 AM", user_email: "sara.lee@sundown.com", user_type: 2, user_id: "$2356222981689442465", user_name: "Sara Lee", upload_count: 6, recent_upload_time_in_millis: 1620705720000 }, relationships: { files: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/submissions/h862cc41180f05a1d418e9a8a38891eaf87e0-$2356222981689442465/relationships/files", related: "https://www.zohoapis.com/workdrive/api/v1/submissions/h862cc41180f05a1d418e9a8a38891eaf87e0-$2356222981689442465/files" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/submissions/h862cc41180f05a1d418e9a8a38891eaf87e0-$2356222981689442465" } }, { id: "vx57jc433ffa2c7524c51a5205d1849bc92fa-55997622", type: "submissions", attributes: { collection_id: "vx57jc433ffa2c7524c51a5205d1849bc92fa", recent_upload_time: "May 22, 08:12 AM", user_type: 0, avatar_url: "https://www.zohoapis.com/workdrive/file?t=user&ID=55997622&fs=thumb&nps=404", user_id: "55997622", user_name: "James Vasanth", upload_count: 2, recent_upload_time_in_millis: 1621651320000 }, relationships: { files: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/submissions/h862cc41180f05a1d418e9a8a38891eaf87e0-55997622/relationships/files", related: "https://www.zohoapis.com/workdrive/api/v1/submissions/h862cc41180f05a1d418e9a8a38891eaf87e0-55997622/files" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/submissions/h862cc41180f05a1d418e9a8a38891eaf87e0-55997622" } } ] }
Show fullGet list of all Collection links
This API fetches the lists of all collection links created by the current user in the given organization.
Path Parameters
team_idstring | Mandatory The unique ID that represents a team. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/teams/{team_id}/collections
Example Response
{ data: [ { data: { id: "vx57jc433ffa2c7524c51a5205d1849bc92fa", type: "collections", attributes: { modified_time_i18: "May 9, 5:42 PM", modifier_name: "Anna Baker", link: "https://www.zohoapis.com/workdrive/collection/vx57jc433ffa2c7524c51a5205d1849bc92fa", input_fields: [], expiration_date: "May 20, 2021, 11:45 AM", expiration_date_in_millis: 1621491300000, created_time_i18: "Aug 9, 5:42 PM", request_user_data: false, total_uploads: 11, modified_time: "May 9, 5:42 PM", modified_time_in_millis: 1620562320000, total_submissions: 23, upload_file_size_limit_in_bytes: 10485760, created_time: "May 9, 5:42 PM", notify_every_submissions: true, upload_file_size_limit: "10 MB", set_upload_limit: false, override_name_exist: false, is_external: false, personal_note: "Analysis potential leads and assign them to the Sales team", is_expired: false, upload_limit_per_user: 0, parent_id: "vx57jc433ffa2c7524c51a5205d1849bc92fa", created_time_in_millis: 1620562320000, creator_name: "Anna Baker", space_id: "15532088", collection_name: "Event Leads", uploader_note: "Share all leads that you have collected in the recent Dubai Trade Fair", status: -1 }, relationships: { submissions: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/collections/7lse92d3ced8a860d4efca7ba1648f7e3f69d/relationships/submissions", related: "https://www.zohoapis.com/workdrive/api/v1/collections/7lse92d3ced8a860d4efca7ba1648f7e3f69d/submissions" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/collections/7lse92d3ced8a860d4efca7ba1648f7e3f69d" } } }, { data: { id: "vx57jc433ffa2c7524c51a5205d1849bc92fa", type: "collections", attributes: { modified_time_i18: "Aug 9, 5:53 PM", modifier_name: "Anna Baker", link: "https://workdrive.zohoexternal.com/collection/vx57jc433ffa2c7524c51a5205d1849bc92fa/external", input_fields: [ { id: 0, field_name: "Name", encrypt_field: false, field_type: "TEXT", is_name_field: true, status: 1 }, { id: 1, field_name: "Phone", encrypt_field: false, field_type: "PHONE", is_name_field: false, status: 1 }, { id: 2, field_name: "Email", encrypt_field: false, field_type: "EMAIL_ID", is_name_field: false, status: 1 } ], expiration_date: "May 20, 2021, 11:45 AM", expiration_date_in_millis: 1621491300000, created_time_i18: "Aug 9, 5:53 PM", request_user_data: true, total_uploads: 11, modified_time: "Aug 9, 5:53 PM", modified_time_in_millis: 1620562320000, total_submissions: 23, upload_file_size_limit_in_bytes: 256000, created_time: "Aug 9, 5:53 PM", notify_every_submissions: true, upload_file_size_limit: "250 KB", set_upload_limit: true, override_name_exist: false, is_external: true, personal_note: "Analysis potential leads and assign them to the Sales team", is_expired: false, upload_limit_per_user: 10, parent_id: "vx57jc433ffa2c7524c51a5205d1849bc92fa", created_time_in_millis: 1620562320000, creator_name: "Anna Baker", space_id: "15532088", collection_name: "Event Leads", uploader_note: "Share all leads that you have collected in the recent Dubai Trade Fair", status: 1 }, relationships: { submissions: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/collections/7lse9afe33b5aa13841d2823067713b701177/relationships/submissions", related: "https://www.zohoapis.com/workdrive/api/v1/collections/7lse9afe33b5aa13841d2823067713b701177/submissions" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/collections/7lse9afe33b5aa13841d2823067713b701177" } } } ] }
Show fullGet list of all user submissions
This API fetches the list of all files submitted by a user using a given link.
The submission id will be created when a user submits files through a collection link for the first time.
Path Parameters
submission_idstring | Mandatory A unique ID that represents each user's file submission via a collection link.
|
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/submissions/{submission_id}/files
Example Response
{ data: [ { id: "vx57jc2db917a963e1456c871070c4dcfc9fb8", type: "files", attributes: { modified_by_zuid: "55997622", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, destination_id: "vx57jc433ffe4c09dc4efd81fe5fa7dd1248dd", storage_info: { size: "43.0 KB", storage_used: "43.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 44884, storage_used_in_bytes: 44884 }, type: "image", created_time_i18: "May 22, 08:12 AM", modified_time_in_millisecond: 1621651320000, opened_time: "May 22, 08:12 AM", status_change_time: "May 22, 08:12 AM", download_url: "https://downloadserver.zoho.com/v1/workdrive/download/vx57jc2db917a963e1456c871070c4dcfc9fb8", comment_badge_count: 0, is_app_associated: false, created_time: "May 22, 08:12 AM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "James Vasanth-dubaievents-May 22, 7:39 AM.jpg", created_by: "James Vasanth", display_html_name: "James Vasanth-dubaievents-May 22, 7:39 AM.jpg", labels: [], parent_id: "m1bhc311ffe4c09dc4efd81fe5fa7dd1248dd", name: "James Vasanth-dubaievents-May 22, 08:12 AM.jpg", status_change_time_in_millisecond: 1621651320000, permalink: "https://www.zohoapis.com/workdrive/file/vx57jc2db917a963e1456c871070c4dcfc9fb8", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "May 22, 08:12 AM", opened_time_i18: "May 22, 08:12 AM", extn: "jpg", shortcut_link: "", status_change_time_i18: "May 22, 08:12 AM", description: "", uploaded_time_in_millisecond: 1621651320000, thumbnail_url: "https://previewengine.zoho.com/thumbnail/WD/vx57jc2db917a963e1456c871070c4dcfc9fb8", title: "", modified_time: "May 22, 08:12 AM", library_id: "oc85p7ce61199aba54737a53965c7f452e72a", icon_class: "img", created_time_in_millisecond: 1621651320000, owner: "55997713", creator: "55997891", uploaded_time_i18: "May 22, 08:12 AM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1621651320000, edit_badge_count: 0, share_data: [], uploaded_time: "May 22, 08:12 AM", has_folders: false, service_type: "upload", display_url_name: "James Vasanth-dubaievents-May+22%2C+7%3A39+AM.jpg", is_unread: false, modified_by: "James Vasanth", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/relationships/folders", related: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/folders" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/relationships/unzip", related: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/unzip" } }, accesschartdata: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/relationships/accesschartdata", related: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/accesschartdata" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/resourceproperty" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/relationships/importfile", related: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/importfile" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/relationships/permissions", related: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/permissions" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/relationships/links", related: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/relationships/copy", related: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/relationships/tasks", related: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/tasks" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/custommetadata" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/m1bhc2db917a963e1456c871070c4dcfc9fb8/relationships/comments", related: "https://www.zohoapis.com/workdrive/api/v1/files/m1bhc2db917a963e1456c871070c4dcfc9fb8/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/previewinfo" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/publiclink" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/parentfolders" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/relationships/versions", related: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/supportshare" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/relationships/timeline", related: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/relationships/files", related: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/files" } }, accessdata: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/relationships/accessdata", related: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/accessdata" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/relationships/entity", related: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/entity" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/relationships/statistics", related: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/relationships/appdata", related: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/vx57jc2db917a963e1456c871070c4dcfc9fb8" } } ] }
Show fullCreate External Collection
This API helps create an external collection. The link created here is used to collect files from anyone on the internet.
You can set custom link settings, such as expiration date, file count limit, and file size limit. External users need not sign in to a WorkDrive account to access the collection link and upload files. Learn more about external collections
Request Body Parameters
parent_idstring | Mandatory A unique ID of the destination folder where the collected files get uploaded. |
collection_namestring | Mandatory The name of the collection. |
personal_notestring | Optional A note is used as reference by the creator of the collection. This note is only visible to the creator of the collection. |
uploader_notestring | Optional A note for users who upload via the collection link. |
expiration_datestring | Optional The date when the collection link expires. The date should be in the format: YYYY-MM-dd / YYYY-MM-dd HH:mm |
is_externalboolean | Mandatory To set the collection link's visibility to either internal organization members or anyone on the internet. |
set_upload_limitboolean | Optional Set "true" to apply a file upload count limit per user. |
upload_limit_per_userint | Optional To set the maximum file upload count limit per user. |
upload_file_size_limitstring | Optional To set the maximum file upload size limit. |
override_name_existboolean | Optional To upload files with the same name as versions to the existing file, otherwise files will be added separately. |
notify_every_submissionsboolean | Optional To notify every user submission with bell notification (web), push notification (mobile), and email notification. |
each_user_each_folder_fieldslist | Optional To create a separate folder for each user to store their files. For an external collection, user name will be the default folder name. If phone number and email address are requested from users, these can also be set as folder names.
|
request_user_databoolean | Mandatory To set whether to request user data or not.
|
input_fieldslist | Optional The field where the user data such as name, phone number, and email address are collected.
|
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/collections
{ data: { attributes: { parent_id: "vx57jc433ffa2c7524c51a5205d1849bc92fa", collection_name: "Event Leads", personal_note: "Analysis potential leads and assign them to the Sales team", uploader_note: "Share all leads that you have collected in the recent Dubai Trade Fair", expiration_date: "2021-05-20 11:45", is_external: "true", set_upload_limit: "true", upload_limit_per_user: "10", upload_file_size_limit: "250 KB", override_name_exist: "false", notify_every_submissions: "true", each_user_each_folder_fields: [ "email" ], request_user_data: "true", input_fields: [ { field_name: "Name", field_type: "TEXT", is_name_field: true }, { field_name: "Phone", field_type: "PHONE" }, { field_name: "Email", field_type: "EMAIL_ID" } ] }, type: "collections" } }
Example Response
{ data: { id: "vx57jc433ffa2c7524c51a5205d1849bc92fa", type: "collections", attributes: { modified_time_i18: "Aug 9, 5:53 PM", modifier_name: "Anna Baker", link: "https://workdrive.zohoexternal.com/collection/vx57jc433ffa2c7524c51a5205d1849bc92fa/external", input_fields: [ { id: 0, field_name: "Name", encrypt_field: false, field_type: "TEXT", is_name_field: true, status: 1 }, { id: 1, field_name: "Phone", encrypt_field: false, field_type: "PHONE", is_name_field: false, status: 1 }, { id: 2, field_name: "Email", encrypt_field: false, field_type: "EMAIL_ID", is_name_field: false, status: 1 } ], each_user_each_folder: true, each_user_each_folder_fields: [ "email" ], expiration_date: "May 20, 2021, 11:45 AM", expiration_date_in_millis: 1621491300000, created_time_i18: "Aug 9, 5:53 PM", request_user_data: true, total_uploads: 11, modified_time: "Aug 9, 5:53 PM", modified_time_in_millis: 1620562320000, total_submissions: 23, upload_file_size_limit_in_bytes: 256000, created_time: "Aug 9, 5:53 PM", notify_every_submissions: true, upload_file_size_limit: "250 KB", set_upload_limit: true, override_name_exist: false, is_external: true, personal_note: "Analysis potential leads and assign them to the Sales team", is_expired: false, upload_limit_per_user: 10, parent_id: "vx57jc433ffa2c7524c51a5205d1849bc92fa", created_time_in_millis: 1620562320000, creator_name: "Anna Baker", space_id: "15532088", collection_name: "Event Leads", uploader_note: "Share all leads that you have collected in the recent Dubai Trade Fair", status: 1 }, relationships: { submissions: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/collections/7lse9afe33b5aa13841d2823067713b701177/relationships/submissions", related: "https://www.zohoapis.com/workdrive/api/v1/collections/7lse9afe33b5aa13841d2823067713b701177/submissions" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/collections/7lse9afe33b5aa13841d2823067713b701177" } } }
Show fullCreate Internal Collection
This API helps create an internal collection: a collect file link that users who are not part of the team cannot access.Team users must sign in to their WorkDrive account to access the collection link and upload files. Learn more about internal collections
Request Body Parameters
parent_idstring | Mandatory A unique ID of the destination folder where the collected files get uploaded. |
collection_namestring | Mandatory The name of the collection. |
personal_notestring | Optional A note is used as reference by the creator of the collection. This note is only visible to the creator of the collection. |
uploader_notestring | Optional A note for users who upload via the collection link. |
expiration_datestring | Optional The date when the collection link expires. The date should be in the format: YYYY-MM-dd / YYYY-MM-dd HH:mm |
is_externalboolean | Mandatory To set the collection link's visibility to either internal organization members or anyone on the internet. |
upload_file_size_limitstring | Optional To limit the size of a single file during submission. |
override_name_existboolean | Optional To upload files with the same name as versions to the existing file, otherwise files will be added separately. |
notify_every_submissionsboolean | Optional To notify every user submission with bell notification (web), push notification (mobile), and email notification. |
each_user_each_folder_fieldslist | Optional To create a separate folder for each user to store their files. For an internal collection, user name will be the default folder name. |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/collections
{ data: { attributes: { parent_id: "vx57jc433ffa2c7524c51a5205d1849bc92fa", collection_name: "Event Leads", personal_note: "Analysis potential leads and assign them to the Sales team", uploader_note: "Share all leads that you have collected in the recent Dubai Trade Fair", expiration_date: "2021-05-20 11:45", is_external: "false", upload_file_size_limit: "10 MB", override_name_exist: "false", notify_every_submissions: "true", each_user_each_folder_fields: [ "name" ] }, type: "collections" } }
Example Response
{ data: { id: "vx57jc433ffa2c7524c51a5205d1849bc92fa", type: "collections", attributes: { modified_time_i18: "May 9, 5:42 PM", modifier_name: "Anna Baker", link: "https://www.zohoapis.com/workdrive/collection/vx57jc433ffa2c7524c51a5205d1849bc92fa", input_fields: [], expiration_date: "May 20, 2021, 11:45 AM", expiration_date_in_millis: 1621491300000, created_time_i18: "Aug 9, 5:42 PM", request_user_data: false, total_uploads: 11, modified_time: "May 9, 5:42 PM", modified_time_in_millis: 1620562320000, total_submissions: 23, upload_file_size_limit_in_bytes: 10485760, created_time: "May 9, 5:42 PM", notify_every_submissions: true, upload_file_size_limit: "10 MB", set_upload_limit: false, override_name_exist: false, is_external: false, personal_note: "Analysis potential leads and assign them to the Sales team", each_user_each_folder: true, each_user_each_folder_fields: [ "name" ], is_expired: false, upload_limit_per_user: 0, parent_id: "vx57jc433ffa2c7524c51a5205d1849bc92fa", created_time_in_millis: 1620562320000, creator_name: "Anna Baker", space_id: "15532088", collection_name: "Event Leads", uploader_note: "Share all leads that you have collected in the recent Dubai Trade Fair", status: 1 }, relationships: { submissions: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/collections/7lse92d3ced8a860d4efca7ba1648f7e3f69d/relationships/submissions", related: "https://www.zohoapis.com/workdrive/api/v1/collections/7lse92d3ced8a860d4efca7ba1648f7e3f69d/submissions" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/collections/7lse92d3ced8a860d4efca7ba1648f7e3f69d" } } }
Show fullConvert External Collection into Internal Collection
This API helps convert an external collection into an internal collection. This will make the collection link accessible only to the team users.
Path Parameters
collection_idstring | Mandatory A unique ID that represents a collection. |
Request Body Parameters
is_externalboolean | Mandatory To set the collection link's visibility to either internal organization members or anyone on the internet.
|
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/collections/{collection_id}
{ data: { attributes: { is_external: "false" }, type: "collections" } }
Example Response
{ data: { id: "vx57jc433ffa2c7524c51a5205d1849bc92fa", type: "collections", attributes: { modified_time_i18: "May 9, 5:42 PM", modifier_name: "Anna Baker", link: "https://www.zohoapis.com/workdrive/collection/vx57jc433ffa2c7524c51a5205d1849bc92fa", input_fields: [], each_user_each_folder: true, each_user_each_folder_fields: [ "name" ], expiration_date: "May 20, 2021, 11:45 AM", expiration_date_in_millis: 1621491300000, created_time_i18: "Aug 9, 5:42 PM", request_user_data: false, total_uploads: 11, modified_time: "May 9, 5:42 PM", modified_time_in_millis: 1620562320000, total_submissions: 23, upload_file_size_limit_in_bytes: 10485760, created_time: "May 9, 5:42 PM", notify_every_submissions: true, upload_file_size_limit: "10 MB", set_upload_limit: false, override_name_exist: false, is_external: false, personal_note: "Analysis potential leads and assign them to the Sales team", is_expired: false, upload_limit_per_user: 0, parent_id: "vx57jc433ffa2c7524c51a5205d1849bc92fa", created_time_in_millis: 1620562320000, creator_name: "Anna Baker", space_id: "15532088", collection_name: "Event Leads", uploader_note: "Share all leads that you have collected in the recent Dubai Trade Fair", status: 1 }, relationships: { submissions: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/collections/7lse92d3ced8a860d4efca7ba1648f7e3f69d/relationships/submissions", related: "https://www.zohoapis.com/workdrive/api/v1/collections/7lse92d3ced8a860d4efca7ba1648f7e3f69d/submissions" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/collections/7lse92d3ced8a860d4efca7ba1648f7e3f69d" } } }
Show fullConvert Internal Collection into External Collection
This API helps convert an internal collection into an external collection. This will make the collection link accessible to anyone on the internet.
Path Parameters
collection_idstring | Mandatory A unique ID that represents a collection. |
Request Body Parameters
is_externalboolean | Mandatory To set the collection link's visibility to either internal organization members or anyone on the internet
|
request_user_databoolean | Mandatory To set whether to request user data or not
|
input_fieldslist | Optional The field where the user data such as name, phone number, and email address are collected.
|
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/collections/{collection_id}
{ data: { attributes: { is_external: "true", request_user_data: "true", input_fields: [ { field_name: "Name", field_type: "TEXT", is_name_field: true } ] }, type: "collections" } }
Example Response
{ data: { id: "vx57jc433ffa2c7524c51a5205d1849bc92fa", type: "collections", attributes: { modified_time_i18: "Aug 9, 5:53 PM", modifier_name: "Anna Baker", link: "https://workdrive.zohoexternal.com/collection/vx57jc433ffa2c7524c51a5205d1849bc92fa/external", input_fields: [ { id: 0, field_name: "Name", encrypt_field: false, field_type: "TEXT", is_name_field: true, status: 1 }, { id: 1, field_name: "Phone", encrypt_field: false, field_type: "PHONE", is_name_field: false, status: 1 }, { id: 2, field_name: "Email", encrypt_field: false, field_type: "EMAIL_ID", is_name_field: false, status: 1 } ], each_user_each_folder: true, each_user_each_folder_fields: [ "name" ], expiration_date: "May 20, 2021, 11:45 AM", expiration_date_in_millis: 1621491300000, created_time_i18: "Aug 9, 5:53 PM", request_user_data: true, total_uploads: 11, modified_time: "Aug 9, 5:53 PM", modified_time_in_millis: 1620562320000, total_submissions: 23, upload_file_size_limit_in_bytes: 256000, created_time: "Aug 9, 5:53 PM", notify_every_submissions: true, upload_file_size_limit: "250 KB", set_upload_limit: true, override_name_exist: false, is_external: true, personal_note: "Analysis potential leads and assign them to the Sales team", is_expired: false, upload_limit_per_user: 10, parent_id: "vx57jc433ffa2c7524c51a5205d1849bc92fa", created_time_in_millis: 1620562320000, creator_name: "Anna Baker", space_id: "15532088", collection_name: "Event Leads", uploader_note: "Share all leads that you have collected in the recent Dubai Trade Fair", status: 1 }, relationships: { submissions: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/collections/7lse9afe33b5aa13841d2823067713b701177/relationships/submissions", related: "https://www.zohoapis.com/workdrive/api/v1/collections/7lse9afe33b5aa13841d2823067713b701177/submissions" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/collections/7lse9afe33b5aa13841d2823067713b701177" } } }
Show fullUpdate Collection Link Settings
This API helps you update the collection link settings, such as expiration date, file count limit, and file size limit.
Path Parameters
collection_idstring | Mandatory A unique ID that represents a collection. |
Request Body Parameters
collection_namestring | Optional The name of the collection |
expiration_datestring | Optional The date when the collection link expires. Date should in format of YYYY-MM-dd / YYYY-MM-dd HH:mm |
upload_limit_per_userint | Optional To set the maximum upload count limit per user. |
each_user_each_folderboolean | Set "each_user_each_folder" as false if you do not want to create a separate folder for each user who upload files using the collection link.
|
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/collections/{collection_id}
{ data: { attributes: { collection_name: "Event Leads - Dubai", expiration_date: "never", upload_limit_per_user: "false", each_user_each_folder: "false" }, type: "collections" } }
Example Response
{ data: { id: "vx57jc433ffa2c7524c51a5205d1849bc92fa", type: "collections", attributes: { modified_time_i18: "May 9, 5:42 PM", modifier_name: "Anna Baker", link: "https://www.zohoapis.com/workdrive/collection/vx57jc433ffa2c7524c51a5205d1849bc92fa", input_fields: [], each_user_each_folder: false, expiration_date_in_millis: -1, created_time_i18: "Aug 9, 5:42 PM", request_user_data: false, total_uploads: 11, modified_time: "May 9, 5:42 PM", modified_time_in_millis: 1620562320000, total_submissions: 23, upload_file_size_limit_in_bytes: 10485760, created_time: "May 9, 5:42 PM", notify_every_submissions: true, upload_file_size_limit: "10 MB", set_upload_limit: false, override_name_exist: false, is_external: false, personal_note: "Analysis potential leads and assign them to the Sales team", is_expired: false, upload_limit_per_user: 0, parent_id: "vx57jc433ffa2c7524c51a5205d1849bc92fa", created_time_in_millis: 1620562320000, creator_name: "Anna Baker", space_id: "15532088", collection_name: "Event Leads - Dubai", uploader_note: "Share all leads that you have collected in the recent Dubai Trade Fair", status: 1 }, relationships: { submissions: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/collections/7lse92d3ced8a860d4efca7ba1648f7e3f69d/relationships/submissions", related: "https://www.zohoapis.com/workdrive/api/v1/collections/7lse92d3ced8a860d4efca7ba1648f7e3f69d/submissions" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/collections/7lse92d3ced8a860d4efca7ba1648f7e3f69d" } } }
Show fullDisable Collection
This API helps in disabling a collection.
Path Parameters
collection_idstring | Mandatory A unique ID that represents a collection. |
Request Body Parameters
statestring | Mandatory Set the state as "stop" to disable the collection. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/collections/{collection_id}
{ data: { attributes: { state: "stop" }, type: "collections" } }
Example Response
{ data: { id: "vx57jc433ffa2c7524c51a5205d1849bc92fa", type: "collections", attributes: { modified_time_i18: "May 9, 5:42 PM", modifier_name: "Anna Baker", link: "https://www.zohoapis.com/workdrive/collection/vx57jc433ffa2c7524c51a5205d1849bc92fa", input_fields: [], expiration_date: "May 20, 2021, 11:45 AM", expiration_date_in_millis: 1621491300000, created_time_i18: "Aug 9, 5:42 PM", request_user_data: false, total_uploads: 11, modified_time: "May 9, 5:42 PM", modified_time_in_millis: 1620562320000, total_submissions: 23, upload_file_size_limit_in_bytes: 10485760, created_time: "May 9, 5:42 PM", notify_every_submissions: true, upload_file_size_limit: "10 MB", set_upload_limit: false, override_name_exist: false, is_external: false, personal_note: "Analysis potential leads and assign them to the Sales team", is_expired: false, upload_limit_per_user: 0, parent_id: "vx57jc433ffa2c7524c51a5205d1849bc92fa", created_time_in_millis: 1620562320000, creator_name: "Anna Baker", space_id: "15532088", collection_name: "Event Leads", uploader_note: "Share all leads that you have collected in the recent Dubai Trade Fair", status: -1 }, relationships: { submissions: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/collections/7lse92d3ced8a860d4efca7ba1648f7e3f69d/relationships/submissions", related: "https://www.zohoapis.com/workdrive/api/v1/collections/7lse92d3ced8a860d4efca7ba1648f7e3f69d/submissions" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/collections/7lse92d3ced8a860d4efca7ba1648f7e3f69d" } } }
Show fullEnable Collection
This API helps in enabling a collection.
If the API returns the error code COL016, then add parent_id in request body parameters with state param.
Path Parameters
collection_idstring | Mandatory A unique ID that represents a collection. |
Request Body Parameters
statestring | Mandatory Set the state as "reactivate" to enable the collection. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/collections/{collection_id}
{ data: { attributes: { state: "reactivate" }, type: "collections" } }
Example Response
{ data: { id: "vx57jc433ffa2c7524c51a5205d1849bc92fa", type: "collections", attributes: { modified_time_i18: "May 9, 5:42 PM", modifier_name: "Anna Baker", link: "https://www.zohoapis.com/workdrive/collection/vx57jc433ffa2c7524c51a5205d1849bc92fa", input_fields: [], expiration_date: "May 20, 2021, 11:45 AM", expiration_date_in_millis: 1621491300000, created_time_i18: "Aug 9, 5:42 PM", request_user_data: false, total_uploads: 11, modified_time: "May 9, 5:42 PM", modified_time_in_millis: 1620562320000, total_submissions: 23, upload_file_size_limit_in_bytes: 10485760, created_time: "May 9, 5:42 PM", notify_every_submissions: true, upload_file_size_limit: "10 MB", set_upload_limit: false, override_name_exist: false, is_external: false, personal_note: "Analysis potential leads and assign them to the Sales team", is_expired: false, upload_limit_per_user: 0, parent_id: "vx57jc433ffa2c7524c51a5205d1849bc92fa", created_time_in_millis: 1620562320000, creator_name: "Anna Baker", space_id: "15532088", collection_name: "Event Leads", uploader_note: "Share all leads that you have collected in the recent Dubai Trade Fair", status: 1 }, relationships: { submissions: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/collections/7lse92d3ced8a860d4efca7ba1648f7e3f69d/relationships/submissions", related: "https://www.zohoapis.com/workdrive/api/v1/collections/7lse92d3ced8a860d4efca7ba1648f7e3f69d/submissions" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/collections/7lse92d3ced8a860d4efca7ba1648f7e3f69d" } } }
Show fullDelete Collection
This API helps in deleting a specific collection.
Path Parameters
collection_idstring | Mandatory A unique ID that represents a collection. |
Example Request
DELETE https://www.zohoapis.com/workdrive/api/v1/collections/{collection_id}
Example Response
204: No Content
Follow Updates
In WorkDrive, you can follow important files and folders to stay up to date on all changes made by collaborators.
For files, you will get notifications for file version updates, renaming, and comments.
For folders, you will get notifications when a file or folder is created, uploaded, added, or removed.
Follow File/Folder
This API helps in following updates on the changes made in a file or folder with notifications.
One can choose the preferred notification setting. It can be either bell notifications, email notifications, or both.
Request Body Parameters
idstring | Mandatory A unique ID for the file or folder. |
watch_preferencejson | Mandatory This represents the notification preference settings. Setting "watch" as true will start following the resource.
Setting "watch" as false will stop following the resource, and one will not receive any notifications. Setting "notifyemail" as true will initiate email notifications for the resource. Setting "notifybell" as true will initiate bell notifications for the resource. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/files
{ data: [ { attributes: { watch_preference: { watch: true, notifyemail: true, notifybell: true } }, id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", type: "files" }, { attributes: { watch_preference: { watch: true, notifyemail: true, notifybell: true } }, id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", type: "files" } ] }
Example Response
{ data: [ { id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, destination_id: "ly9zme5724e019a8e4cb48632945b1296be0a", storage_info: { size: "48.0 KB", storage_used: "48.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 50081, storage_used_in_bytes: 50081 }, type: "image", created_time_i18: "Apr 12, 9:45 PM", modified_time_in_millisecond: 1618244132643, opened_time: "Apr 12, 9:45 PM", status_change_time: "Apr 12, 9:45 PM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 12, 9:45 PM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "Screenshot from 2021-03-22 10-40-22.png", user_access_time: "Apr 12, 9:45 PM", created_by: "Zylker Creation", display_html_name: "Screenshot from 2021-03-22 10-40-22.png", labels: [], user_access_time_i18: "Apr 12, 9:45 PM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a", name: "Screenshot from 2021-03-22 10-40-22.png", status_change_time_in_millisecond: 1618244132643, permalink: "https://www.zohoapis.com/workdrive/file/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", favorite: true, new_badge_count: 0, status: 1, modified_time_i18: "Apr 12, 9:45 PM", opened_time_i18: "Apr 12, 9:45 PM", extn: "png", user_access_time_in_millis: 1618244132643, shortcut_link: "", status_change_time_i18: "Apr 12, 9:45 PM", description: "", uploaded_time_in_millisecond: 1618244132645, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", title: "", modified_time: "Apr 12, 9:45 PM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "img", created_time_in_millisecond: 1618244132643, owner: "747937818", creator: "747938014", capabilities: { can_read: true, can_share: true, can_remove_share: false, can_delete: false, can_edit: 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: true, can_share_support: true, can_label: true, can_checkout: true, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: true, can_trash_files: true }, uploaded_time_i18: "Apr 12, 9:45 PM", is_external_upload: false, watch_preference: { watch: true, notifyemail: true, notifybell: true }, opened_time_in_millisecond: 1618244132643, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 12, 9:45 PM", has_folders: false, service_type: "upload", recent_action: "last_modified_time", display_url_name: "Screenshot+from+2021-03-22+10-40-22.png", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2" } }, { id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, destination_id: "ly9zme5724e019a8e4cb48632945b1296be0a", storage_info: { size: "92.0 KB", storage_used: "92.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 94427, storage_used_in_bytes: 94427 }, type: "image", created_time_i18: "Apr 12, 9:45 PM", modified_time_in_millisecond: 1618244131914, opened_time: "Apr 12, 9:45 PM", status_change_time: "Apr 12, 9:45 PM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 12, 9:45 PM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "Screenshot from 2021-04-09 11-30-24.png", user_access_time: "Apr 12, 9:45 PM", created_by: "Zylker Creation", display_html_name: "Screenshot from 2021-04-09 11-30-24.png", labels: [], user_access_time_i18: "Apr 12, 9:45 PM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a", name: "Screenshot from 2021-04-09 11-30-24.png", status_change_time_in_millisecond: 1618244131914, permalink: "https://www.zohoapis.com/workdrive/file/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", favorite: true, new_badge_count: 0, status: 1, modified_time_i18: "Apr 12, 9:45 PM", opened_time_i18: "Apr 12, 9:45 PM", extn: "png", user_access_time_in_millis: 1618244131914, shortcut_link: "", status_change_time_i18: "Apr 12, 9:45 PM", description: "", uploaded_time_in_millisecond: 1618244131917, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", title: "", modified_time: "Apr 12, 9:45 PM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "img", created_time_in_millisecond: 1618244131914, owner: "747937818", creator: "747938014", capabilities: { can_read: true, can_share: true, can_remove_share: false, can_delete: false, can_edit: 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: true, can_share_support: true, can_label: true, can_checkout: true, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: true, can_trash_files: true }, uploaded_time_i18: "Apr 12, 9:45 PM", is_external_upload: false, watch_preference: { watch: true, notifyemail: true, notifybell: true }, opened_time_in_millisecond: 1618244131914, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 12, 9:45 PM", has_folders: false, service_type: "upload", recent_action: "last_modified_time", display_url_name: "Screenshot+from+2021-04-09+11-30-24.png", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2" } } ], meta: { search_result_count: 0, action_id: "2774428000000002034" } }
Show fullUnfollow File/Folder
This API will remove follow updates for the file or folder.
Request Body Parameters
idstring | Mandatory A unique ID for the file or folder |
watch_preferencejson | Mandatory This represents the notification preference settings. Setting "watch" as 'false' will stop following the resource, and one will not receive any notifications. To follow again, set "watch" as 'true'. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/files
{ data: [ { attributes: { watch_preference: { watch: false } }, id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", type: "files" }, { attributes: { watch_preference: { watch: false } }, id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", type: "files" } ] }
Example Response
{ data: [ { id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, destination_id: "ly9zme5724e019a8e4cb48632945b1296be0a", storage_info: { size: "48.0 KB", storage_used: "48.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 50081, storage_used_in_bytes: 50081 }, type: "image", created_time_i18: "Apr 12, 9:45 PM", modified_time_in_millisecond: 1618244132643, opened_time: "Apr 12, 9:45 PM", status_change_time: "Apr 12, 9:45 PM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 12, 9:45 PM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "Screenshot from 2021-03-22 10-40-22.png", user_access_time: "Apr 12, 9:45 PM", created_by: "Zylker Creation", display_html_name: "Screenshot from 2021-03-22 10-40-22.png", labels: [], user_access_time_i18: "Apr 12, 9:45 PM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a", name: "Screenshot from 2021-03-22 10-40-22.png", status_change_time_in_millisecond: 1618244132643, permalink: "https://www.zohoapis.com/workdrive/file/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", favorite: true, new_badge_count: 0, status: 1, modified_time_i18: "Apr 12, 9:45 PM", opened_time_i18: "Apr 12, 9:45 PM", extn: "png", user_access_time_in_millis: 1618244132643, shortcut_link: "", status_change_time_i18: "Apr 12, 9:45 PM", description: "", uploaded_time_in_millisecond: 1618244132645, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", title: "", modified_time: "Apr 12, 9:45 PM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "img", created_time_in_millisecond: 1618244132643, owner: "747937818", creator: "747938014", capabilities: { can_read: true, can_share: true, can_remove_share: false, can_delete: false, can_edit: 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: true, can_share_support: true, can_label: true, can_checkout: true, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: true, can_trash_files: true }, uploaded_time_i18: "Apr 12, 9:45 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: true, notifybell: true }, opened_time_in_millisecond: 1618244132643, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 12, 9:45 PM", has_folders: false, service_type: "upload", recent_action: "last_modified_time", display_url_name: "Screenshot+from+2021-03-22+10-40-22.png", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2" } }, { id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", type: "files", attributes: { modified_by_zuid: "747938014", is_locked: false, conv_engine_type: 1, is_fillable_resource: false, is_published: false, destination_id: "ly9zme5724e019a8e4cb48632945b1296be0a", storage_info: { size: "92.0 KB", storage_used: "92.0 KB", files_count: 0, folders_count: 0, size_in_bytes: 94427, storage_used_in_bytes: 94427 }, type: "image", created_time_i18: "Apr 12, 9:45 PM", modified_time_in_millisecond: 1618244131914, opened_time: "Apr 12, 9:45 PM", status_change_time: "Apr 12, 9:45 PM", download_url: "https://download-accl.zoho.com/v1/workdrive/download/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", comment_badge_count: 0, is_app_associated: false, created_time: "Apr 12, 9:45 PM", lock_status: 2, is_folder: false, resource_type: 2501, is_email_in_upload: false, display_attr_name: "Screenshot from 2021-04-09 11-30-24.png", user_access_time: "Apr 12, 9:45 PM", created_by: "Zylker Creation", display_html_name: "Screenshot from 2021-04-09 11-30-24.png", labels: [], user_access_time_i18: "Apr 12, 9:45 PM", org_id: "ly9zmae16b43c258f458a9a57ac02c4f8d763", parent_id: "ly9zme5724e019a8e4cb48632945b1296be0a", name: "Screenshot from 2021-04-09 11-30-24.png", status_change_time_in_millisecond: 1618244131914, permalink: "https://www.zohoapis.com/workdrive/file/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", favorite: true, new_badge_count: 0, status: 1, modified_time_i18: "Apr 12, 9:45 PM", opened_time_i18: "Apr 12, 9:45 PM", extn: "png", user_access_time_in_millis: 1618244131914, shortcut_link: "", status_change_time_i18: "Apr 12, 9:45 PM", description: "", uploaded_time_in_millisecond: 1618244131917, thumbnail_url: "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", title: "", modified_time: "Apr 12, 9:45 PM", library_id: "ly9zme5724e019a8e4cb48632945b1296be0a", icon_class: "img", created_time_in_millisecond: 1618244131914, owner: "747937818", creator: "747938014", capabilities: { can_read: true, can_share: true, can_remove_share: false, can_delete: false, can_edit: 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: true, can_share_support: true, can_label: true, can_checkout: true, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: true, can_trash_files: true }, uploaded_time_i18: "Apr 12, 9:45 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: true, notifybell: true }, opened_time_in_millisecond: 1618244131914, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Apr 12, 9:45 PM", has_folders: false, service_type: "upload", recent_action: "last_modified_time", display_url_name: "Screenshot+from+2021-04-09+11-30-24.png", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/folders", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/folders" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/comments", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/previewinfo" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/unzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/unzip" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/publiclink" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/resourceproperty" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/parentfolders" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/importfile", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/importfile" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/versions", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/supportshare" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/permissions", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/permissions" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/timeline", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/files", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/files" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/links", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/copy", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/tasks", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/tasks" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/entity", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/entity" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/custommetadata" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/statistics", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/relationships/appdata", related: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/files/ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2" } } ], meta: { search_result_count: 0, action_id: "2774428000000002034" } }
Show fullData Templates and Custom Fields
In WorkDrive, you can create data templates and associate the required files and folders with them by adding custom information or properties. Once you associate files and folders to a data template with custom values, you can easily search for and manage data using the Data Templates filter. Learn more about Data Templates in WorkDrive
Custom Field Types
Custom Field Type | Value Format | Supported field_properties |
text | string |
|
multiline_text | string |
|
number | all type of numeric value |
|
datetime | date time in milli second |
|
date | date in milli second |
|
yes_or_no | boolean |
|
dropdown | value in given choice list |
|
radio | value in given choice list |
|
checkbox | values in given choice list as JSON Array |
|
valid email address |
|
Create Data Template
This API creates a new data template.
A new 'data_template_id' is created when you create a new data template.
Path Parameters
team_idstring | Mandatory A unique ID of the team in which the data template is created. |
Request Body Parameters
namestring | Mandatory A name for the data template. |
descriptionstring | Optional A description for the data template. |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/teams/{team_id}/datatemplates
{ data: { attributes: { name: "Recruitment - 2020", description: "Associate files and folders of all candidates registered for recruitment in 2020" }, type: "datatemplates" } }
Example Response
{ data: { id: "nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001", type: "datatemplates", attributes: { created_time_i18: "Sep 7, 6:40 PM", name: "Recruitment - 2020", modified_by: "15077877", description: "Associate files and folders of all candidates registered for recruitment in 2020", modified_by_user: "Anna Baker", team_id: "nrkroc4c5f3259e2a410da17c3915ea990dde", custom_fields_count: 0, created_time_in_millisecond: 1631020235366, created_by: "15077877", created_by_user: "Anna Baker", status: true }, relationships: { customfields: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/datatemplates/nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001/relationships/customfields", related: "https://www.zohoapis.com/workdrive/api/v1/datatemplates/nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001/customfields" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/datatemplates/nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001" } } }
Show fullRename Data Template
This API helps in changing the name of a data template.
Path Parameters
data_template_idstring | Mandatory A unique ID of the data template. |
Request Body Parameters
namestring | Mandatory A name for the data template. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/datatemplates/{data_template_id}
{ data: { attributes: { name: "Recruitment - 2021" }, type: "datatemplates" } }
Example Response
{ data: { id: "nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001", type: "datatemplates", attributes: { name: "Recruitment - 2021", modified_by: "15077877", description: "Associate files and folders of all candidates registered for recruitment in 2020", modified_by_user: "Anna Baker", team_id: "nrkroc4c5f3259e2a410da17c3915ea990dde", custom_fields_count: 0, created_time_in_millisecond: 0, created_by: "15077877", created_by_user: "Anna Baker", status: true }, relationships: { customfields: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/datatemplates/nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001/relationships/customfields", related: "https://www.zohoapis.com/workdrive/api/v1/datatemplates/nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001/customfields" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/datatemplates/nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001" } } }
Show fullChange Data Template Description
This API helps in changing the description of a data template.
Path Parameters
data_template_idstring | Mandatory A unique ID of the data template. |
Request Body Parameters
descriptionstring | Mandatory A description for the data template. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/datatemplates/{data_template_id}
{ data: { attributes: { description: "Associate files and folders of all candidates registered for recruitment in 2021" }, type: "datatemplates" } }
Example Response
{ data: { id: "nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001", type: "datatemplates", attributes: { name: "Recruitment - 2021", modified_by: "15077877", description: "Associate files and folders of all candidates registered for recruitment in 2021", modified_by_user: "Anna Baker", team_id: "nrkroc4c5f3259e2a410da17c3915ea990dde", custom_fields_count: 0, created_time_in_millisecond: 0, created_by: "15077877", created_by_user: "Anna Baker", status: true }, relationships: { customfields: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/datatemplates/nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001/relationships/customfields", related: "https://www.zohoapis.com/workdrive/api/v1/datatemplates/nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001/customfields" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/datatemplates/nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001" } } }
Show fullEnable/Disable Data Template
This API helps in enabling or disabling a data template.
When you disable a template, you will not be able to edit the template. You must enable the template again to make any changes. Also, you cannot associate new files and folders with a disabled data template, but you can still disassociate files and folders from it.
Path Parameters
data_template_idstring | Mandatory A unique ID of the data template. |
Request Body Parameters
statusboolean | Mandatory Mention "true", if you want to keep the data template in an active state, and "false" to disable the data template. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/datatemplates/{data_template_id}
{ data: { attributes: { status: "false" }, type: "datatemplates" } }
Example Response
{ data: { id: "nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001", type: "datatemplates", attributes: { name: "Recruitment - 2021", modified_by: "15077877", description: "Associate files and folders of all candidates registered for recruitment in 2021", modified_by_user: "Anna Baker", team_id: "nrkroc4c5f3259e2a410da17c3915ea990dde", custom_fields_count: 0, created_time_in_millisecond: 0, created_by: "15077877", created_by_user: "Anna Baker", status: false }, relationships: { customfields: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/datatemplates/nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001/relationships/customfields", related: "https://www.zohoapis.com/workdrive/api/v1/datatemplates/nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001/customfields" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/datatemplates/nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001" } } }
Show fullDelete Data Template
This API deletes a data template.
Path Parameters
data_template_idstring | Mandatory A unique ID of the data template that needs to be deleted. |
Example Request
DELETE https://www.zohoapis.com/workdrive/api/v1/datatemplates/{data_template_id}
Example Response
204: No Content
Create Custom Field
This API helps in creating a custom field within a data template.
A 'custom_field_id' is created when a new custom field is created within a data template.
Path Parameters
data_template_idstring | Mandatory A unique ID of the data template. |
Request Body Parameters
display_namestring | Mandatory A name for the custom field. |
typestring | Mandatory This represents the data type of the custom field. |
field_propertiesjson | Optional This represents the variables used for different data types. |
choicesjson | Optional This represents the list of choices for choice type custom fields (dropdown, radio, checkbox). |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/datatemplates/{data_template_id}/customfields
{ data: { attributes: { display_name: "Role", type: "dropdown", field_properties: { is_mandatory: true, description: "Role of the candidate", default_value: "" }, choices: [ { key: "Developer" }, { key: "Designers" }, { key: "Marketer" } ] }, type: "customfields" } }
Example Response
{ data: { id: "nrkroc4c5f3259e2a410da17c3915ea990dde-MjQwMDAwMDA1ODEwMDEtMjQwMDAwMDA1ODIwMDI", type: "customfields", attributes: { data_template_id: "nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001", column_name: "CF61", index: 1, display_name: "Role", type: "dropdown", field_properties: { description: "Role of the candidate", is_mandatory: true, default_value: "" }, choices: [ { key: "Developer" }, { key: "Designers" }, { key: "Marketer" } ] }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/customfields/nrkroc4c5f3259e2a410da17c3915ea990dde-MjQwMDAwMDA1ODEwMDEtMjQwMDAwMDA1ODIwMDI" } } }
Show fullUpdate Custom Field
This API helps in updating custom field data.
Path Parameters
custom_field_idstring | Mandatory A unique ID of the custom field. |
Request Body Parameters
display_namestring | Optional A name for the custom field. |
field_propertiesjson | Optional This represents the variables used for different data types. |
choicesjson | Optional This represents the list of choices for choice type custom fields (dropdown, radio, checkbox).
|
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/customfields/{custom_field_id}
{ data: { attributes: { display_name: "Candidate Role", field_properties: { is_mandatory: false }, choices: [ { key: "Quality Analyst", operation: "add" }, { key: "Designers", value: "Designer", operation: "update" }, { key: "Marketer", operation: "delete" } ] }, type: "customfields" } }
Example Response
{ data: { id: "nrkroc4c5f3259e2a410da17c3915ea990dde-MjQwMDAwMDA1ODEwMDEtMjQwMDAwMDA1ODIwMDI", type: "customfields", attributes: { column_name: "CF61", index: 1, display_name: "Candidate Role", type: "dropdown", field_properties: { description: "Role of the candidate", is_mandatory: false, default_value: "" }, choices: [ { key: "Developer" }, { key: "Designer" }, { key: "Quality Analyst" } ] }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/customfields/nrkroc4c5f3259e2a410da17c3915ea990dde-MjQwMDAwMDA1ODEwMDEtMjQwMDAwMDA1ODIwMDI" } } }
Delete Custom Field
This API helps in deleting a custom field.
Path Parameters
custom_field_idstring | Mandatory A unique ID of the custom field. |
Example Request
DELETE https://www.zohoapis.com/workdrive/api/v1/customfields/{custom_field_id}
Example Response
204: No Content
Associate File/Folder to Data Template
This API helps in associating a single file or folder to a specific data template.
Request Body Parameters
resource_idstring | Mandatory A unique ID of the file or folder. |
data_template_idstring | Mandatory A unique ID of the data template. |
custom_datalist | Mandatory List of custom fields with value. |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/custommetadata
{ data: { attributes: { resource_id: "nrkrocca1fef45ba243319cb8643393b6b52b", data_template_id: "nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001", custom_data: [ { custom_field_id: "nrkroc4c5f3259e2a410da17c3915ea990dde-MjQwMDAwMDA1ODEwMDEtMjQwMDAwMDA1ODIwMDE", value: "John" }, { custom_field_id: "nrkroc4c5f3259e2a410da17c3915ea990dde-MjQwMDAwMDA1ODEwMDEtMjQwMDAwMDA1ODIwMDI", value: "Developer" } ] }, type: "custommetadata" } }
Example Response
{ data: { id: "nrkrocca1fef45ba243319cb8643393b6b52b-24000000581001", type: "custommetadata", attributes: { data_template_id: "nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001", name: "Recruitment - 2021", description: "Associate files and folders of all candidates registered for recruitment in 2021", resource_id: "nrkrocca1fef45ba243319cb8643393b6b52b", custom_data: [ { custom_field_id: "nrkrocca1fef45ba243319cb8643393b6b52b-MjQwMDAwMDA1ODEwMDEtMjQwMDAwMDA1ODIwMDE", display_name: "Candidate Name", type: "text", column_name: "CF60", field_properties: { description: "Name of the candidate", is_mandatory: true, default_value: "", max_char_length: "50" }, value: "John", index: 0 }, { custom_field_id: "nrkrocca1fef45ba243319cb8643393b6b52b-MjQwMDAwMDA1ODEwMDEtMjQwMDAwMDA1ODIwMDI", display_name: "Candidate Role", type: "dropdown", column_name: "CF61", field_properties: { description: "Role of the candidate", is_mandatory: false, default_value: "" }, value: "Developer", index: 1, choices: [ { key: "Developer" }, { key: "Designer" }, { key: "Marketer" } ] } ], is_associated_without_cf: false, status: true }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/custommetadata/nrkrocca1fef45ba243319cb8643393b6b52b-24000000581001" } } }
Show fullAssociate Multiple Files/Folders to Data Template
This API helps in associating multiple files or folders to a specific data template.
Request Body Parameters
resource_idstring | Mandatory A unique ID of the file or folder. |
data_template_idstring | Mandatory A unique ID of the data template. |
custom_datalist | Mandatory List of custom fields with value. |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/custommetadata
{ data: [ { attributes: { resource_id: "nrkrod816f237389b4c05a65fc15b4a4dacc3", data_template_id: "nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001", custom_data: [ { custom_field_id: "nrkroc4c5f3259e2a410da17c3915ea990dde-MjQwMDAwMDA1ODEwMDEtMjQwMDAwMDA1ODIwMDE", value: "Alex" }, { custom_field_id: "nrkroc4c5f3259e2a410da17c3915ea990dde-MjQwMDAwMDA1ODEwMDEtMjQwMDAwMDA1ODIwMDI", value: "Developer" } ] }, type: "custommetadata" }, { attributes: { resource_id: "nrkro483e7e45e2d04efdb5a11c00ce68def5", data_template_id: "nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001", custom_data: [ { custom_field_id: "nrkroc4c5f3259e2a410da17c3915ea990dde-MjQwMDAwMDA1ODEwMDEtMjQwMDAwMDA1ODIwMDE", value: "Peter" }, { custom_field_id: "nrkroc4c5f3259e2a410da17c3915ea990dde-MjQwMDAwMDA1ODEwMDEtMjQwMDAwMDA1ODIwMDI", value: "Developer" } ] }, type: "custommetadata" } ] }
Example Response
{ data: [ { id: "nrkrod816f237389b4c05a65fc15b4a4dacc3-24000000581001", type: "custommetadata", attributes: { data_template_id: "nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001", name: "Recruitment - 2021", description: "Associate files and folders of all candidates registered for recruitment in 2021", resource_id: "nrkrod816f237389b4c05a65fc15b4a4dacc3", custom_data: [ { custom_field_id: "nrkrod816f237389b4c05a65fc15b4a4dacc3-MjQwMDAwMDA1ODEwMDEtMjQwMDAwMDA1ODIwMDE", display_name: "Candidate Name", type: "text", column_name: "CF60", field_properties: { description: "Name of the candidate", is_mandatory: true, default_value: "", max_char_length: "50" }, value: "Peter", index: 0 }, { custom_field_id: "nrkrod816f237389b4c05a65fc15b4a4dacc3-MjQwMDAwMDA1ODEwMDEtMjQwMDAwMDA1ODIwMDI", display_name: "Candidate Role", type: "dropdown", column_name: "CF61", field_properties: { description: "Role of the candidate", is_mandatory: false, default_value: "" }, value: "Developer", index: 1, choices: [ { key: "Developer" }, { key: "Designer" }, { key: "Marketer" } ] } ], is_associated_without_cf: false, status: true }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/custommetadata/nrkrod816f237389b4c05a65fc15b4a4dacc3-24000000581001" } }, { id: "nrkro483e7e45e2d04efdb5a11c00ce68def5-24000000581001", type: "custommetadata", attributes: { data_template_id: "nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001", name: "Recruitment - 2021", description: "Associate files and folders of all candidates registered for recruitment in 2021", resource_id: "nrkro483e7e45e2d04efdb5a11c00ce68def5", custom_data: [ { custom_field_id: "nrkro483e7e45e2d04efdb5a11c00ce68def5-MjQwMDAwMDA1ODEwMDEtMjQwMDAwMDA1ODIwMDE", display_name: "Candidate Name", type: "text", column_name: "CF60", field_properties: { description: "Name of the candidate", is_mandatory: true, default_value: "", max_char_length: "50" }, value: "Alex", index: 0 }, { custom_field_id: "nrkro483e7e45e2d04efdb5a11c00ce68def5-MjQwMDAwMDA1ODEwMDEtMjQwMDAwMDA1ODIwMDI", display_name: "Candidate Role", type: "dropdown", column_name: "CF61", field_properties: { description: "Role of the candidate", is_mandatory: false, default_value: "" }, value: "Developer", index: 1, choices: [ { key: "Developer" }, { key: "Designer" }, { key: "Marketer" } ] } ], is_associated_without_cf: false, status: true }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/custommetadata/nrkro483e7e45e2d04efdb5a11c00ce68def5-24000000581001" } } ] }
Show fullUpdate Values of Associated Files/Folders
This API helps in editing the custom filed values provided with the associated files and folder.
Path Parameters
custommetadata_idstring | Mandatory A unique ID that represents the association of a file/folder to a data template. |
Request Body Parameters
custom_datalist | Mandatory List of custom fields with value. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/custommetadata/{custommetadata_id}
{ data: { attributes: { custom_data: [ { custom_field_id: "nrkroc4c5f3259e2a410da17c3915ea990dde-MjQwMDAwMDA1ODEwMDEtMjQwMDAwMDA1ODIwMDI", value: "Designer" } ] }, type: "custommetadata" } }
Example Response
{ data: { id: "nrkrocca1fef45ba243319cb8643393b6b52b-24000000581001", type: "custommetadata", attributes: { data_template_id: "nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001", name: "Recruitment - 2021", description: "Associate files and folders of all candidates registered for recruitment in 2021", resource_id: "nrkrocca1fef45ba243319cb8643393b6b52b", custom_data: [ { custom_field_id: "nrkrocca1fef45ba243319cb8643393b6b52b-MjQwMDAwMDA1ODEwMDEtMjQwMDAwMDA1ODIwMDE", display_name: "Candidate Name", type: "text", column_name: "CF60", field_properties: { description: "Name of the candidate", is_mandatory: true, default_value: "", max_char_length: "50" }, value: "John", index: 0 }, { custom_field_id: "nrkrocca1fef45ba243319cb8643393b6b52b-MjQwMDAwMDA1ODEwMDEtMjQwMDAwMDA1ODIwMDI", display_name: "Candidate Role", type: "dropdown", column_name: "CF61", field_properties: { description: "Role of the candidate", is_mandatory: false, default_value: "" }, value: "Designer", index: 1, choices: [ { key: "Developer" }, { key: "Designer" }, { key: "Marketer" } ] } ], is_associated_without_cf: false, status: true }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/custommetadata/nrkrocca1fef45ba243319cb8643393b6b52b-24000000581001" } } }
Show fullDisassociate Files/Folders from Data Template
This API disassociates a file or folder from a data template.
Path Parameters
custommetadata_idstring | Mandatory A unique ID that represents the association of a file/folder to a data template. |
Example Request
DELETE https://www.zohoapis.com/workdrive/api/v1/custommetadata/{custommetadata_id}
Example Response
204: No Content
Get List of Custom Fields
This API fetches all custom fields created within a data template.
Path Parameters
data_template_idstring | Mandatory A unique ID of the data template. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/datatemplates/{data_template_id}/customfields
Example Response
{ data: [ { id: "nrkroc4c5f3259e2a410da17c3915ea990dde-MjQwMDAwMDA1ODEwMDEtMjQwMDAwMDA1ODIwMDE", type: "customfields", attributes: { data_template_id: "nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001", column_name: "CF60", index: 0, display_name: "Candidate Name", type: "text", field_properties: { description: "Name of the candidate", is_mandatory: true, default_value: "", max_char_length: "50" } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/customfields/nrkroc4c5f3259e2a410da17c3915ea990dde-MjQwMDAwMDA1ODEwMDEtMjQwMDAwMDA1ODIwMDE" } }, { id: "nrkroc4c5f3259e2a410da17c3915ea990dde-MjQwMDAwMDA1ODEwMDEtMjQwMDAwMDA1ODIwMDI", type: "customfields", attributes: { data_template_id: "nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001", column_name: "CF61", index: 1, display_name: "Candidate Role", type: "dropdown", field_properties: { description: "Role of the candidate", is_mandatory: false, default_value: "" }, choices: [ { key: "Developer" }, { key: "Designer" }, { key: "Marketer" } ] }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/customfields/nrkroc4c5f3259e2a410da17c3915ea990dde-MjQwMDAwMDA1ODEwMDEtMjQwMDAwMDA1ODIwMDI" } } ] }
Show fullLabels
Labels help you to identify and access files and folders easily across different locations in WorkDrive. You can add labels based on priority, status, task, and much more. Once you add a label to files and folders, you can view all those items under each label. Learn more about Labels here.
Get Label
This API fetches the details of a Label.
Path Parameters
label_idstring | The unique ID of a label |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/labels/{label_id}
Example Response
{ data: { id: "5nek5a28a8c9201f64a07b7196524264ed528-181767000000449002", type: "labels", attributes: { color: "14A765", name: "Training materials", index: 2, team_id: "5nek5a28a8c9201f64a07b7196524264ed528", type: 1, label_id: "181767000000449002" }, relationships: { files: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/labels/5nek5a28a8c9201f64a07b7196524264ed528-181767000000449002/relationships/files", related: "https://www.zohoapis.com/workdrive/api/v1/labels/5nek5a28a8c9201f64a07b7196524264ed528-181767000000449002/files" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/labels/5nek5a28a8c9201f64a07b7196524264ed528-181767000000449002" } } }
Show fullGet All Labels of the User
This API fetches all the labels created by the user.
Path Parameters
team_member_idstring | The unique ID of the team member that is created when a member is added into a team. |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/users/{team_member_id}/labels
Example Response
{ data: [ { id: "5nek5a28a8c9201f64a07b7196524264ed528-181767000000280006", type: "labels", attributes: { color: "8F8F8F", name: "Following", index: 0, team_id: "5nek5a28a8c9201f64a07b7196524264ed528", type: 3, label_id: "181767000000280006" }, relationships: { files: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/labels/5nek5a28a8c9201f64a07b7196524264ed528-181767000000280006/relationships/files", related: "https://www.zohoapis.com/workdrive/api/v1/labels/5nek5a28a8c9201f64a07b7196524264ed528-181767000000280006/files" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/labels/5nek5a28a8c9201f64a07b7196524264ed528-181767000000280006" } }, { id: "5nek5a28a8c9201f64a07b7196524264ed528-181767000000449002", type: "labels", attributes: { color: "14A765", name: "Training materials", index: 1, team_id: "5nek5a28a8c9201f64a07b7196524264ed528", type: 1, label_id: "181767000000449002" }, relationships: { files: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/labels/5nek5a28a8c9201f64a07b7196524264ed528-181767000000449002/relationships/files", related: "https://www.zohoapis.com/workdrive/api/v1/labels/5nek5a28a8c9201f64a07b7196524264ed528-181767000000449002/files" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/labels/5nek5a28a8c9201f64a07b7196524264ed528-181767000000449002" } }, { id: "5nek5a28a8c9201f64a07b7196524264ed528-181767000000449001", type: "labels", attributes: { color: "FBE983", name: "Product Design", index: 2, team_id: "5nek5a28a8c9201f64a07b7196524264ed528", type: 1, label_id: "181767000000449001" }, relationships: { files: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/labels/5nek5a28a8c9201f64a07b7196524264ed528-181767000000449001/relationships/files", related: "https://www.zohoapis.com/workdrive/api/v1/labels/5nek5a28a8c9201f64a07b7196524264ed528-181767000000449001/files" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/labels/5nek5a28a8c9201f64a07b7196524264ed528-181767000000449001" } } ] }
Show fullCreate Label
This API helps in creating a label.
Request Body Parameters
namestring | Mandatory Name of the label |
colorstring | Mandatory Color to represent the label. It refers to the 6 digit color code (you can use any color code, however only limited colors are available in the web app user interface). |
user_idstring | Mandatory A unique ID of the team member that is created when a member is added into a team. |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/labels
{ data: { attributes: { name: "Product Design", color: "FBE983", user_id: "5nek5a28a8c9201f64a07b7196524264ed528-181767000000047009" }, type: "labels" } }
Example Response
{ data: { id: "5nek5a28a8c9201f64a07b7196524264ed528-181767000000449001", type: "labels", attributes: { color: "FBE983", name: "Product Design", index: 4, team_id: "5nek5a28a8c9201f64a07b7196524264ed528", type: 1, label_id: "181767000000449001" }, relationships: { files: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/labels/5nek5a28a8c9201f64a07b7196524264ed528-181767000000449001/relationships/files", related: "https://www.zohoapis.com/workdrive/api/v1/labels/5nek5a28a8c9201f64a07b7196524264ed528-181767000000449001/files" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/labels/5nek5a28a8c9201f64a07b7196524264ed528-181767000000449001" } } }
Show fullRename Label
This API helps in renaming the label.
Path Parameters
label_idstring | Mandatory The unique ID of a label |
Request Body Parameters
namestring | Mandatory Name of the label |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/labels/{label_id}
{ data: { attributes: { name: "Training materials" }, type: "labels" } }
Example Response
{ data: { id: "5nek5a28a8c9201f64a07b7196524264ed528-181767000000449002", type: "labels", attributes: { color: "9A9CFF", name: "Training materials", index: 5, team_id: "5nek5a28a8c9201f64a07b7196524264ed528", type: 1, label_id: "181767000000449002" }, relationships: { files: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/labels/5nek5a28a8c9201f64a07b7196524264ed528-181767000000449002/relationships/files", related: "https://www.zohoapis.com/workdrive/api/v1/labels/5nek5a28a8c9201f64a07b7196524264ed528-181767000000449002/files" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/labels/5nek5a28a8c9201f64a07b7196524264ed528-181767000000449002" } } }
Show fullChange Label Color
This API helps in changing the label color.
Path Parameters
label_idstring | Mandatory The unique ID of a label |
Request Body Parameters
colorstring | Mandatory Color to represent the label. It refers to the 6 digit color code.
|
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/labels/{label_id}
{ data: { attributes: { color: "14A765" }, type: "labels" } }
Example Response
{ data: { id: "5nek5a28a8c9201f64a07b7196524264ed528-181767000000449002", type: "labels", attributes: { color: "14A765", name: "Training materials", index: 5, team_id: "5nek5a28a8c9201f64a07b7196524264ed528", type: 1, label_id: "181767000000449002" }, relationships: { files: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/labels/5nek5a28a8c9201f64a07b7196524264ed528-181767000000449002/relationships/files", related: "https://www.zohoapis.com/workdrive/api/v1/labels/5nek5a28a8c9201f64a07b7196524264ed528-181767000000449002/files" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/labels/5nek5a28a8c9201f64a07b7196524264ed528-181767000000449002" } } }
Show fullAdd Label to File/Folder
This API helps in adding labels to the required files and folders.
Path Parameters
label_idstring | Mandatory The unique ID of a label |
Request Body Parameters
idstring | Mandatory A unique ID of the file or folder |
resource_idstring | Mandatory A unique ID of the file or folder |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/labels/{label_id}/relationships/files
{ data: [ { attributes: { resource_id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2" }, id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", type: "files" }, { attributes: { resource_id: "ly9zm3c10f18ca7e3422db10f5b335d33b0cc" }, id: "ly9zm3c10f18ca7e3422db10f5b335d33b0cc", type: "files" } ] }
Example Response
204: No Content
Remove Label from File/Folder
This API helps in removing labels from files and folders.
Path Parameters
label_idstring | Mandatory The unique ID of a label |
Request Body Parameters
idstring | Mandatory A unique ID of the file or folder |
resource_idstring | Mandatory A unique ID of the file or folder |
Example Request
DELETE https://www.zohoapis.com/workdrive/api/v1/labels/{label_id}/relationships/files
{ data: [ { attributes: { resource_id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2" }, id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", type: "files" }, { attributes: { resource_id: "ly9zm3c10f18ca7e3422db10f5b335d33b0cc" }, id: "ly9zm3c10f18ca7e3422db10f5b335d33b0cc", type: "files" } ] }
Example Response
204: No Content
Delete Label
This API helps in deleting a label.
Path Parameters
label_idstring | Mandatory The unique ID of a label |
Example Request
DELETE https://www.zohoapis.com/workdrive/api/v1/labels/{label_id}
Example Response
204: No Content
Templates
OVERVIEW:
Templates are preset layouts that help you create files with consistent file settings, such as style, design, and formatting, including the default or primary content. Zoho WorkDrive allows you to create or save templates for documents and spreadsheets via Zoho Writer and Sheet, respectively.
Templates are present within what we call, a "Template Library", which are of three classes: My Template Library, Org Template Library and Public Template Library. Template Libraries have categories which can be used to organize Templates.
A Template cannot be present in more than one category.
Get My Templates Library ID
Every user of WorkDrive has a "My Template Library", which is created by default during the signup. This Library contains all My Templates and their categories, which will be visible or accessible only to the user.
This API fetches the My Templates Library ID of the user.
Path Parameters
team_member_idstring | Mandatory The team-member-id of the user, which is of the form "{team-id}-{member-id}", obtained through the "Currentuser API" |
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
filter[type]string | Optional The value must be the integer "2" for the Template Library |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/users/{team_member_id}/libraries
Example Response
{ data: [ { id: "rabj041c9f3ac33cb4153aa46fd1f07743f0b", type: "libraries", attributes: { capabilities: { can_read: true, can_favourite: true, can_share: true, can_remove_share: false, can_delete: true, can_edit: false, can_manage: true, can_read_fill: false, can_create_files: true, can_upload_files: true, can_trash: true, can_rename: false, can_restore: false, can_copy: false, can_move: false, can_zip: true, can_download: true, can_emailattach: true, can_publish: false, can_org_publish: false, can_checkout: false, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: false, can_create_comment: false, can_delete_comment: false, can_edit_comment: false, can_replyto_comment: false, can_trash_files: true, can_share_files: true, can_leave: false, can_add_members: false, can_join: false, can_download_files: true, is_admin: true }, view_pref: { sort_by: "created_time", sort_order: "asc", filtered_by: "all", layout: "list" }, parent_id: "oc85p35a40ed1efea46119d3f1c321f60e470", library_type: 2, library_name: "default_template_library", library_kind: 3 }, relationships: { permissions: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/libraries/rabj041c9f3ac33cb4153aa46fd1f07743f0b/relationships/permissions", related: "https://www.zohoapis.com/workdrive/api/v1/libraries/rabj041c9f3ac33cb4153aa46fd1f07743f0b/permissions" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/libraries/rabj041c9f3ac33cb4153aa46fd1f07743f0b/relationships/files", related: "https://www.zohoapis.com/workdrive/api/v1/libraries/rabj041c9f3ac33cb4153aa46fd1f07743f0b/files" } }, categories: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/libraries/rabj041c9f3ac33cb4153aa46fd1f07743f0b/relationships/categories", related: "https://www.zohoapis.com/workdrive/api/v1/libraries/rabj041c9f3ac33cb4153aa46fd1f07743f0b/categories" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/libraries/rabj041c9f3ac33cb4153aa46fd1f07743f0b" } } ] }
Show fullGet Org Templates Library ID
Every team in WorkDrive has an "Org Template Library", which is created by default during the team creation. This Library contains all Org Templates and their categories, which will be visible and can be used only by the members of the team.
This API fetches the Org Templates Library ID of the team.
Only template admins can create, edit, delete, and manage Org Templates. All admins are template admins by default. Team admins can assign template admin role to team members, if required.
Path Parameters
team_idstring | Mandatory The unique ID that represents a team. |
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
filter[type]string | Optional The value must be the integer "2" for the template library |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/teams/{team_id}/libraries
Example Response
{ data: [ { id: "t4y5t30481213b4ee415d85a111634df62b63", type: "libraries", attributes: { capabilities: { can_read: true, can_favourite: true, can_share: true, can_remove_share: true, can_delete: true, can_edit: false, can_manage: true, can_read_fill: false, can_create_files: true, can_upload_files: true, can_trash: true, can_rename: false, can_restore: false, can_copy: false, can_move: false, can_zip: true, can_download: true, can_emailattach: true, can_publish: false, can_org_publish: false, can_checkout: false, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: false, can_create_comment: false, can_delete_comment: false, can_edit_comment: false, can_replyto_comment: false, can_trash_files: true, can_share_files: true, can_leave: true, can_add_members: false, can_join: false, can_download_files: true, is_admin: true }, view_pref: { sort_by: "last_modified", sort_order: "asc", filtered_by: "all", layout: "list" }, parent_id: "oc85p35a40ed1efea46119d3f1c321f60e470", library_type: 2, library_name: "default_template_library", library_kind: 4 }, relationships: { permissions: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/libraries/t4y5t30481213b4ee415d85a111634df62b63/relationships/permissions", related: "https://www.zohoapis.com/workdrive/api/v1/libraries/t4y5t30481213b4ee415d85a111634df62b63/permissions" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/libraries/t4y5t30481213b4ee415d85a111634df62b63/relationships/files", related: "https://www.zohoapis.com/workdrive/api/v1/libraries/t4y5t30481213b4ee415d85a111634df62b63/files" } }, categories: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/libraries/t4y5t30481213b4ee415d85a111634df62b63/relationships/categories", related: "https://www.zohoapis.com/workdrive/api/v1/libraries/t4y5t30481213b4ee415d85a111634df62b63/categories" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/libraries/t4y5t30481213b4ee415d85a111634df62b63" } } ] }
Show fullGet Public Templates Library ID
Public Templates are common templates which are publicly shared to all users of WorkDrive, which are present within the "Public Template Library". Any WorkDrive user can view and use Public Templates.
This API fetches the Public Templates Library ID.
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
filter[type]string | Mandatory The value should be the integer "2" for the template library |
filter[space]string | Mandatory The value should be the string "template" denoting template library |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/libraries?filter%5Btype%5D=2&filter%5Bspace%5D=template
Example Response
{ data: [ { id: "lh6rdTMPLIBtemplate", type: "libraries", attributes: { capabilities: { can_read: true, can_favourite: true, can_share: false, can_remove_share: false, can_delete: false, can_edit: false, can_manage: false, can_read_fill: false, can_create_files: false, can_upload_files: false, can_trash: false, can_rename: false, can_restore: false, can_copy: false, can_move: false, can_zip: true, can_download: true, can_emailattach: true, can_publish: false, can_org_publish: false, can_checkout: false, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: false, can_create_comment: false, can_delete_comment: false, can_edit_comment: false, can_replyto_comment: false, can_trash_files: false, can_share_files: false, can_leave: false, can_add_members: false, can_join: false, can_download_files: true, is_admin: false }, view_pref: { sort_by: "created_time", sort_order: "desc", filtered_by: "all", layout: "grid" }, parent_id: "-1", library_type: 2, library_name: "default_template_library" }, relationships: { permissions: { links: { self: "https://workdrive.localzoho.com/api/v1/libraries/lh6rdTMPLIBtemplate/relationships/permissions", related: "https://workdrive.localzoho.com/api/v1/libraries/lh6rdTMPLIBtemplate/permissions" } }, files: { links: { self: "https://workdrive.localzoho.com/api/v1/libraries/lh6rdTMPLIBtemplate/relationships/files", related: "https://workdrive.localzoho.com/api/v1/libraries/lh6rdTMPLIBtemplate/files" } }, categories: { links: { self: "https://workdrive.localzoho.com/api/v1/libraries/lh6rdTMPLIBtemplate/relationships/categories", related: "https://workdrive.localzoho.com/api/v1/libraries/lh6rdTMPLIBtemplate/categories" } }, publiccategories: { links: { self: "https://workdrive.localzoho.com/api/v1/libraries/lh6rdTMPLIBtemplate/relationships/publiccategories", related: "https://workdrive.localzoho.com/api/v1/libraries/lh6rdTMPLIBtemplate/publiccategories" } } }, links: { self: "https://workdrive.localzoho.com/api/v1/libraries/lh6rdTMPLIBtemplate" } } ] }
Show fullGet Template Library Info
This API fetches the resource information of the template library, such as capabilities and view preferences.
Path Parameters
library_idstring | Mandatory The template library ID of My Templates/Org Templates/Public Templates |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/libraries/{library_id}
Example Response
{ data: { id: "rabj041c9f3ac33cb4153aa46fd1f07743f0b", type: "libraries", attributes: { capabilities: { can_read: true, can_favourite: true, can_share: true, can_remove_share: false, can_delete: true, can_edit: false, can_manage: true, can_read_fill: false, can_create_files: true, can_upload_files: true, can_trash: true, can_rename: false, can_restore: false, can_copy: false, can_move: false, can_zip: true, can_download: true, can_emailattach: true, can_publish: false, can_org_publish: false, can_checkout: false, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: false, can_create_comment: false, can_delete_comment: false, can_edit_comment: false, can_replyto_comment: false, can_trash_files: true, can_share_files: true, can_leave: false, can_add_members: false, can_join: false, can_download_files: true, is_admin: true }, view_pref: { sort_by: "created_time", sort_order: "asc", filtered_by: "all", layout: "list" }, parent_id: "oc85p35a40ed1efea46119d3f1c321f60e470", library_type: 2, library_name: "default_template_library" }, relationships: { permissions: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/libraries/rabj041c9f3ac33cb4153aa46fd1f07743f0b/relationships/permissions", related: "https://www.zohoapis.com/workdrive/api/v1/libraries/rabj041c9f3ac33cb4153aa46fd1f07743f0b/permissions" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/libraries/rabj041c9f3ac33cb4153aa46fd1f07743f0b/relationships/files", related: "https://www.zohoapis.com/workdrive/api/v1/libraries/rabj041c9f3ac33cb4153aa46fd1f07743f0b/files" } }, categories: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/libraries/rabj041c9f3ac33cb4153aa46fd1f07743f0b/relationships/categories", related: "https://www.zohoapis.com/workdrive/api/v1/libraries/rabj041c9f3ac33cb4153aa46fd1f07743f0b/categories" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/libraries/rabj041c9f3ac33cb4153aa46fd1f07743f0b" } } }
Show fullGet Template Library Permissions
This API fetches the permission details of a Template Library.
Path Parameters
library_idstring | Mandatory The template library ID of My Templates/Org Templates/Public Templates |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/libraries/{library_id}/permissions
Example Response
{ data: [ { id: "t4y5t30481213b4ee415d85a111634df62b63-56865813", type: "permissions", attributes: { email_id: "reyansh.ahuja@zylker.com", shared_time_in_millis: 1559575942198, shared_by: "", expiry_in_millis: 0, relation_type: 0, expiration_date: "", share_to_entity_info: { display_name: "Zylker Creation", email_id: "reyansh.ahuja@zylker.com", avatar_url: "https://contacts.localzoho.com/file?t=user&ID=56865813&fs=thumb&nps=404" }, share_to_member_type: -1, role_id: 1, shared_time_i18: "Jun 3, 2019, 9:02 PM", shared_time: "Jun 3, 2019, 9:02 PM", shared_status: "ACTIVE", can_link_to_docs: true, owner: "57056915", allow_sharing_outside: false, shared_type: "workspace", delete_from_propagated_space: false, display_name: "Zylker Creation", message: "", share_to: "56865813", is_expired: false, shared_to_member_type: -1, avatar_url: "https://contacts.localzoho.com/file?t=user&ID=56865813&fs=thumb&nps=404", is_password_protected: false, resource_id: "t4y5t30481213b4ee415d85a111634df62b63", permalink: "https://www.zohoapis.com/workdrive/file/t4y5t30481213b4ee415d85a111634df62b63", shared_by_zuid: "57056915" }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/permissions/t4y5t30481213b4ee415d85a111634df62b63-56865813" } } ] }
Show fullGet all Templates from a Template Library
This API fetches all the "active" templates within a template library.
Path Parameters
library_idstring | Mandatory The template library ID of My Templates/Org Templates/Public Templates |
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
filter[type]string | Optional value could be:
|
filter[category_id]string | Optional This filter can be used when only the templates within a particular template category are required |
sortstring | Optional The value to the param "sort" should follow the pattern:
|
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/libraries/{library_id}/files
Example Response
{ data: [ { id: "mvfyde371e9a5562241d89372f876919d3788", type: "files", attributes: { modified_by_zuid: "56865813", is_locked: false, conv_engine_type: 0, is_fillable_resource: false, is_published: false, destination_id: "t4y5t30481213b4ee415d85a111634df62b63", storage_info: { files_count: 0, folders_count: 0, size_in_bytes: 0, storage_used_in_bytes: 0, storage_used_by_app_in_bytes: 0, storage_used_by_workdrive_in_bytes: 0 }, type: "writer", created_time_i18: "Nov 8, 2:57 PM", associated_data_templates: [], modified_time_in_millisecond: 1636363627555, status_change_time: "Nov 8, 2:57 PM", download_url: "https://downloadserver.localzoho.com/v1/workdrive/download/mvfyde371e9a5562241d89372f876919d3788", comment_badge_count: 0, is_app_associated: false, created_time: "Nov 8, 2:57 PM", lock_status: 2, is_folder: false, resource_type: 2001, is_email_in_upload: false, display_attr_name: "qrq3fqfqr", created_by: "Zylker Creation", display_html_name: "qrq3fqfqr", labels: [], parent_id: "t4y5t30481213b4ee415d85a111634df62b63", name: "qrq3fqfqr", status_change_time_in_millisecond: 1636363627555, permalink: "https://writer.localzoho.com/writer/open/mvfyde371e9a5562241d89372f876919d3788", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Nov 8, 2:57 PM", extn: "zwriter", shortcut_link: "", status_change_time_i18: "Nov 8, 2:57 PM", description: "", uploaded_time_in_millisecond: 1636363627245, thumbnail_url: "https://previewengine.localzoho.com/thumbnail/WD/mvfyde371e9a5562241d89372f876919d3788", title: "", modified_time: "Nov 8, 2:57 PM", library_id: "t4y5t30481213b4ee415d85a111634df62b63", icon_class: "writer", created_time_in_millisecond: 1636363627245, owner: "57056915", creator: "56865813", capabilities: { can_read: true, can_share: false, can_remove_share: false, can_delete: true, can_edit: true, can_upload_files: true, can_trash: true, can_rename: true, can_restore: false, can_copy: true, can_move: false, can_zip: true, can_download: true, can_emailattach: true, can_publish: false, can_create_task: true, can_share_support: false, can_label: true, can_delist_file: false, can_associate_data_template: true, can_favorite: true, can_checkout: true, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: true, can_trash_files: true }, uploaded_time_i18: "Nov 8, 2:57 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: "Nov 8, 2:57 PM", has_folders: false, service_type: "zw", display_url_name: "qrq3fqfqr", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/folders", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/folders" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/unzip", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/unzip" } }, accesschartdata: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/accesschartdata", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/accesschartdata" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/resourceproperty" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/importfile", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/importfile" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/permissions", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/permissions" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/links", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/copy", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/tasks", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/tasks" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/custommetadata" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/comments", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/previewinfo" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/publiclink" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/parentfolders" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/versions", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/supportshare" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/timeline", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/files", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/files" } }, accessdata: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/accessdata", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/accessdata" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/entity", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/entity" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/statistics", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/appdata", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788" } } ] }
Show fullGet all Templates in a Template Category
This API fetches all the "active" templates within a template category.
Path Parameters
category_idstring | Mandatory The template category ID |
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
filter[type]string | Optional value could be:
|
sortstring | Optional The value to the param "sort" should follow the pattern:
|
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/category/{category_id}/files
Example Response
{ data: [ { id: "mvfyde371e9a5562241d89372f876919d3788", type: "files", attributes: { modified_by_zuid: "56865813", is_locked: false, conv_engine_type: 0, is_fillable_resource: false, is_published: false, destination_id: "t4y5t30481213b4ee415d85a111634df62b63", storage_info: { files_count: 0, folders_count: 0, size_in_bytes: 0, storage_used_in_bytes: 0, storage_used_by_app_in_bytes: 0, storage_used_by_workdrive_in_bytes: 0 }, type: "writer", created_time_i18: "Nov 8, 2:57 PM", associated_data_templates: [], modified_time_in_millisecond: 1636363627555, status_change_time: "Nov 8, 2:57 PM", download_url: "https://downloadserver.localzoho.com/v1/workdrive/download/mvfyde371e9a5562241d89372f876919d3788", comment_badge_count: 0, is_app_associated: false, created_time: "Nov 8, 2:57 PM", lock_status: 2, is_folder: false, resource_type: 2001, is_email_in_upload: false, display_attr_name: "qrq3fqfqr", created_by: "Zylker Creation", display_html_name: "qrq3fqfqr", labels: [], parent_id: "t4y5t30481213b4ee415d85a111634df62b63", name: "qrq3fqfqr", status_change_time_in_millisecond: 1636363627555, permalink: "https://writer.localzoho.com/writer/open/mvfyde371e9a5562241d89372f876919d3788", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Nov 8, 2:57 PM", extn: "zwriter", shortcut_link: "", status_change_time_i18: "Nov 8, 2:57 PM", description: "", uploaded_time_in_millisecond: 1636363627245, thumbnail_url: "https://previewengine.localzoho.com/thumbnail/WD/mvfyde371e9a5562241d89372f876919d3788", title: "", modified_time: "Nov 8, 2:57 PM", library_id: "t4y5t30481213b4ee415d85a111634df62b63", icon_class: "writer", created_time_in_millisecond: 1636363627245, owner: "57056915", creator: "56865813", capabilities: { can_read: true, can_share: false, can_remove_share: false, can_delete: true, can_edit: true, can_upload_files: true, can_trash: true, can_rename: true, can_restore: false, can_copy: true, can_move: false, can_zip: true, can_download: true, can_emailattach: true, can_publish: false, can_create_task: true, can_share_support: false, can_label: true, can_delist_file: false, can_associate_data_template: true, can_favorite: true, can_checkout: true, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: true, can_trash_files: true }, uploaded_time_i18: "Nov 8, 2:57 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: "Nov 8, 2:57 PM", has_folders: false, service_type: "zw", display_url_name: "qrq3fqfqr", is_unread: false, modified_by: "Zylker Creation", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/folders", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/folders" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/unzip", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/unzip" } }, accesschartdata: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/accesschartdata", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/accesschartdata" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/resourceproperty" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/importfile", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/importfile" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/permissions", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/permissions" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/links", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/copy", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/tasks", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/tasks" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/custommetadata" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/comments", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/previewinfo" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/publiclink" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/parentfolders" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/versions", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/supportshare" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/timeline", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/files", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/files" } }, accessdata: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/accessdata", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/accessdata" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/entity", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/entity" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/statistics", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/appdata", related: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788" } } ] }
Show fullGet Category Info
This API fetches the resource information of a template category, such as name, and library ID.
Path Parameters
category_idstring | Mandatory The template category ID |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/category/{category_id}
Example Response
{ data: { id: "ntp2ode5ad3a2eb054a0c845a24f2381852c9", type: "category", attributes: { category_name: "My Category", library_id: "ntp2oe1674ac34a8f429aa9ad52e2c55de8a8", status: 1 }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/category/ntp2ode5ad3a2eb054a0c845a24f2381852c9" } } }
Get list of Categories
This API fetches all the active template categories within a template library (My Templates or Org Templates).
Path Parameters
library_idstring | Mandatory The template library ID of My Templates/Org Templates/Public Templates |
Example Request
GET https://www.zohoapis.com/workdrive/api/v1/libraries/{library_id}/categories
Example Response
{ data: [ { id: "ntp2o497e00aef2944ab3a752b16d5f2a0197", type: "category", attributes: { category_name: "My Category 8", library_id: "ntp2oe1674ac34a8f429aa9ad52e2c55de8a8", status: 1 }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/category/ntp2o497e00aef2944ab3a752b16d5f2a0197" } }, { id: "ntp2ode5ad3a2eb054a0c845a24f2381852c9", type: "category", attributes: { category_name: "My Category", library_id: "ntp2oe1674ac34a8f429aa9ad52e2c55de8a8", status: 1 }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/category/ntp2ode5ad3a2eb054a0c845a24f2381852c9" } } ] }
Show fullCreate Category
This API creates a new template category within a template library (My Templates or Org Templates).
Request Body Parameters
category_namestring | Mandatory Name of the category |
library_idstring | Mandatory The template library ID of My Templates/Org Templates where the category is to be created |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/category
{ data: { attributes: { category_name: "Marketing", library_id: "ly9zm3c10f18ca7e3422db10f5b335d33b0cc" }, type: "category" } }
Example Response
{ data: { id: "ntp2o497e00aef2944ab3a752b16d5f2a0197", type: "category", attributes: { category_name: "My Category 8", library_id: "ntp2oe1674ac34a8f429aa9ad52e2c55de8a8", status: 1 }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/category/ntp2o497e00aef2944ab3a752b16d5f2a0197" } } }
Save File as Template
This API saves any Zoho format file (i.e., Writer, Sheet, or Show) in WorkDrive as a template (to My Templates or Org Templates).
Path Parameters
library_idstring | Mandatory The template library ID of My Templates/Org Templates/Public Templates where the template is to be saved |
Request Body Parameters
resource_idstring | Mandatory The resource ID of the Zoho format file which is to be saved as a template |
namestring | Mandatory Name of the newly saved template |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/files/{library_id}/saveastemplate
{ data: [ { attributes: { resource_id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", name: "Marketing Template" }, type: "files" } ] }
Example Response
{ data: [ { id: "la6u1f12110c4f9a54bec9367c8ca5d91b89d", type: "files", attributes: { modified_by_zuid: "940668", is_locked: false, conv_engine_type: 0, is_fillable_resource: false, is_published: false, destination_id: "rabj0c77da12d4c1f4fe39d4c269919e57d4d", storage_info: { files_count: 0, folders_count: 0, size_in_bytes: 0, storage_used_in_bytes: 0, storage_used_by_workdrive_in_bytes: 0, storage_used_by_app_in_bytes: 0 }, type: "writer", created_time_i18: "Nov 23, 12:22 PM", modified_time_in_millisecond: 1637650331725, opened_time: "Nov 23, 12:22 PM", status_change_time: "Nov 23, 12:22 PM", download_url: "https://downloadserver.localzoho.com/v1/workdrive/download/la6u1f12110c4f9a54bec9367c8ca5d91b89d", comment_badge_count: 0, is_app_associated: false, created_time: "Nov 23, 12:22 PM", lock_status: 2, is_folder: false, resource_type: 2001, is_email_in_upload: false, display_attr_name: "Copy of My temp", user_access_time: "Nov 23, 12:22 PM", created_by: "jee j", display_html_name: "Copy of My temp", labels: [], user_access_time_i18: "Nov 23, 12:22 PM", org_id: "d73mf85e5258237e240408744f8181acd0809", parent_id: "rabj0c77da12d4c1f4fe39d4c269919e57d4d", name: "Copy of My temp", status_change_time_in_millisecond: 1637650331725, permalink: "https://writer.localzoho.com/writer/open/la6u1f12110c4f9a54bec9367c8ca5d91b89d", favorite: false, new_badge_count: 0, status: 1, modified_time_i18: "Nov 23, 12:22 PM", opened_time_i18: "Nov 23, 12:22 PM", extn: "zwriter", user_access_time_in_millis: 1637650331761, shortcut_link: "", status_change_time_i18: "Nov 23, 12:22 PM", description: "", uploaded_time_in_millisecond: 1637650331286, thumbnail_url: "https://previewengine.localzoho.com/thumbnail/WD/la6u1f12110c4f9a54bec9367c8ca5d91b89d", title: "", modified_time: "Nov 23, 12:22 PM", library_id: "rabj0c77da12d4c1f4fe39d4c269919e57d4d", icon_class: "writer", created_time_in_millisecond: 1637650331286, owner: "55101720", creator: "940668", capabilities: { can_read: true, can_share: false, can_remove_share: false, can_delete: true, can_edit: true, can_upload_files: true, can_trash: true, can_rename: true, can_restore: false, can_copy: true, can_move: false, can_zip: true, can_download: true, can_emailattach: true, can_publish: true, can_create_task: true, can_share_support: true, can_label: true, can_delist_file: false, can_associate_data_template: true, can_favorite: true, can_checkout: true, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: true, can_create_comment: true, can_trash_files: true }, uploaded_time_i18: "Nov 23, 12:22 PM", is_external_upload: false, watch_preference: { watch: false, notifyemail: false, notifybell: false }, opened_time_in_millisecond: 1637650331761, edit_badge_count: 0, share_data: [], data_template_id_to_mandate: "", uploaded_time: "Nov 23, 12:22 PM", has_folders: false, service_type: "zw", display_url_name: "Copy+of+My+temp", is_unread: false, modified_by: "jee j", embed_props: {} }, relationships: { folders: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/folders", related: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/folders" } }, unzip: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/unzip", related: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/unzip" } }, accesschartdata: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/accesschartdata", related: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/accesschartdata" } }, resourceproperty: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/resourceproperty", related: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/resourceproperty" } }, shortcut: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/shortcut", related: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/shortcut" } }, importfile: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/importfile", related: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/importfile" } }, permissions: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/permissions", related: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/permissions" } }, saveastemplate: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/saveastemplate", related: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/saveastemplate" } }, links: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/links", related: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/links" } }, copy: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/copy", related: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/copy" } }, previewzip: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/previewzip", related: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/previewzip" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/tasks", related: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/tasks" } }, custommetadata: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/custommetadata", related: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/custommetadata" } }, comments: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/comments", related: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/comments" } }, previewinfo: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/previewinfo", related: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/previewinfo" } }, publiclink: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/publiclink", related: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/publiclink" } }, parentfolders: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/parentfolders", related: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/parentfolders" } }, versions: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/versions", related: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/versions" } }, supportshare: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/supportshare", related: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/supportshare" } }, timeline: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/timeline", related: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/timeline" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/files", related: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/files" } }, accessdata: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/accessdata", related: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/accessdata" } }, breadcrumbs: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/breadcrumbs", related: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/breadcrumbs" } }, entity: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/entity", related: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/entity" } }, statistics: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/statistics", related: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/statistics" } }, appdata: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/appdata", related: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/appdata" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d" } } ] }
Show fullAssign/Remove Template Admin role
Only template admins can create, edit, delete, and manage Org Templates. All admins are template admins by default.
Team admins can assign or remove the template admin role of team members, if required using this API.
Path Parameters
team_member_idstring | Mandatory The team-member-id of the user, which is of the form "{team-id}-{member-id}", obtained through the "Currentuser API" |
Request Body Parameters
is_org_template_adminboolean | Mandatory Boolean - true/ false to assign or remove the template admin role, respectively. |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/users/{team_member_id}
{ data: { attributes: { is_org_template_admin: "true" }, type: "users" } }
Example Response
{ data: { id: "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012", type: "users", attributes: { email_id: "reyansh.ahuja@zylker.com", member_type: 1, theme_color: "28B294", getting_started: 1, is_org_template_admin: true, favoritedfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, default_view_type: 2, view_pref: { sort_by: "last_modified", sort_order: "desc", layout: "list" }, edition: "TEAM", unread_count_myspace: 0, mig_status: 0, last_login_time_in_millisecond: 0, files_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, invited_time: 1618250069143, user_type: 1, labeledfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, role_id: 31, preferred_view: "TEAM", is_sync_enabled: true, has_myfolder: true, last_accessed_library: "", is_mobile_enabled: true, last_accessed_folder: "", enable_myspace_restriction_all: false, connected_devices: 0, outgoingfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, capabilities: { can_access_myfolder: true, can_have_org_templates: true, can_sync: true, can_create_team: true }, incomingfiles_view_pref: { sort_by: "shared_time", sort_order: "desc", filtered_by: "all", layout: "list" }, app_names: [], is_personal_exist: false, display_name: "Zylker Creation", zuid: "747938058", trashedfiles_view_pref: { sort_by: "last_modified", sort_order: "desc", filtered_by: "all", layout: "list" }, transfer_ownership_information: { status: 3 }, avatar_url: "https://contacts.zoho.com/file?t=user&ID=747938058&fs=thumb&nps=404", allowed_myspace_storage: -1, can_transfer_ownership: true, is_unread_myspace: false, invited_time_i18: "Apr 12, 11:24 PM", zid_type: 262144, status: "DELETED" }, relationships: { privatespace: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/privatespace", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/privatespace" } }, teams: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/teams", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/teams" } }, devices: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/devices", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/devices" } }, records: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/records", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/records" } }, enterprise: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/enterprise", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/enterprise" } }, incomingfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/incomingfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/incomingfiles" } }, libraries: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/libraries", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/libraries" } }, favoritedfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/favoritedfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/favoritedfiles" } }, groups: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/groups", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/groups" } }, labels: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/labels", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/labels" } }, recentfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/recentfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/recentfiles" } }, license: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/license", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/license" } }, recordsuggestions: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/recordsuggestions", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/recordsuggestions" } }, organization: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/organization", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/organization" } }, collaborators: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/collaborators", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/collaborators" } }, labeledfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/labeledfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/labeledfiles" } }, incomingfolders: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/incomingfolders", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/incomingfolders" } }, workspaces: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/workspaces", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/workspaces" } }, unreadfiles: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/unreadfiles", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/unreadfiles" } }, tasks: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/tasks", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/tasks" } }, notifications: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/notifications", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/notifications" } }, contacts: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/contacts", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/contacts" } }, apps: { links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/apps", related: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/apps" } } }, links: { self: "https://www.zohoapis.com/workdrive/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012" } } }
Show fullChange Sort Type and Order
This API changes the sort type (Name/Last Modified/Time Created) and sort order (ascending/descending) of templates within a Template Library.
Path Parameters
library_idstring | Mandatory The template library ID of My Templates/Org Templates/Public Templates |
Request Body Parameters
view_prefjson | Mandatory The object pattern while changing the sort type or sort order of a template library is:
|
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/libraries/{library_id}
{ data: { attributes: { view_pref: { sort_by: "created_time", sort_order: "desc", filtered_by: "all", layout: "grid" } }, type: "libraries" } }
Example Response
{ data: { id: "t4y5t30481213b4ee415d85a111634df62b63", type: "libraries", attributes: { capabilities: { can_read: true, can_favourite: true, can_share: true, can_remove_share: false, can_delete: true, can_edit: false, can_manage: true, can_read_fill: false, can_create_files: true, can_upload_files: true, can_trash: true, can_rename: false, can_restore: false, can_copy: false, can_move: false, can_zip: true, can_download: true, can_emailattach: true, can_publish: false, can_org_publish: false, can_checkout: false, can_cancel_checkout: false, can_discard_checkout: false, can_checkin: false, can_read_comment: false, can_create_comment: false, can_delete_comment: false, can_edit_comment: false, can_replyto_comment: false, can_trash_files: true, can_share_files: true, can_leave: false, can_add_members: false, can_join: false, can_download_files: true, is_admin: true }, view_pref: { sort_by: "last_modified", sort_order: "asc", filtered_by: "all", layout: "list" }, parent_id: "oc85p35a40ed1efea46119d3f1c321f60e470", library_type: 2, library_name: "default_template_library" }, relationships: { permissions: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/libraries/t4y5t30481213b4ee415d85a111634df62b63/relationships/permissions", related: "https://www.zohoapis.com/workdrive/api/v1/libraries/t4y5t30481213b4ee415d85a111634df62b63/permissions" } }, files: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/libraries/t4y5t30481213b4ee415d85a111634df62b63/relationships/files", related: "https://www.zohoapis.com/workdrive/api/v1/libraries/t4y5t30481213b4ee415d85a111634df62b63/files" } }, categories: { links: { self: "https://www.zohoapis.com/workdrive/api/v1/libraries/t4y5t30481213b4ee415d85a111634df62b63/relationships/categories", related: "https://www.zohoapis.com/workdrive/api/v1/libraries/t4y5t30481213b4ee415d85a111634df62b63/categories" } } }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/libraries/t4y5t30481213b4ee415d85a111634df62b63" } } }
Show fullRename Category
This API renames a template category.
Path Parameters
category_idstring | Mandatory The template category ID |
Request Body Parameters
category_namestring | Mandatory The new name of the category |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/category/{category_id}
{ data: { attributes: { category_name: "Marketing" }, type: "category" } }
Example Response
{ data: { id: "ntp2ode5ad3a2eb054a0c845a24f2381852c9", type: "category", attributes: { category_name: "My Category", library_id: "ntp2oe1674ac34a8f429aa9ad52e2c55de8a8", status: 1 }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/category/ntp2ode5ad3a2eb054a0c845a24f2381852c9" } } }
Delete Category
This API deletes a template category permanently.
When a template category is deleted, all the templates within that category will not be deleted and those templates will fall into the 'All' category listing.
Path Parameters
category_idstring | Mandatory The template category ID |
Request Body Parameters
statusinteger | Mandatory The integer "61" to delete a template category |
Example Request
PATCH https://www.zohoapis.com/workdrive/api/v1/category/{category_id}
{ data: { attributes: { status: "61" }, type: "category" } }
Example Response
{ data: { id: "ntp2ode5ad3a2eb054a0c845a24f2381852c9", type: "category", attributes: { category_name: "My Category", library_id: "ntp2oe1674ac34a8f429aa9ad52e2c55de8a8", status: 61 }, links: { self: "https://www.zohoapis.com/workdrive/api/v1/category/ntp2ode5ad3a2eb054a0c845a24f2381852c9" } } }
Update Template Category
This API associates a template to a different template category.
Path Parameters
category_idstring | Mandatory The category_id into which the template needs to be put |
Request Body Parameters
idstring | Mandatory The template ID |
resource_idstring | Mandatory The template ID |
Example Request
POST https://www.zohoapis.com/workdrive/api/v1/category/{category_id}/relationships/files
{ data: [ { attributes: { resource_id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2" }, id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", type: "files" }, { attributes: { resource_id: "ly9zm3c10f18ca7e3422db10f5b335d33b0cc" }, id: "ly9zm3c10f18ca7e3422db10f5b335d33b0cc", type: "files" } ] }
Example Response
204: No Content
Remove Template Category
This API removes category from a template. Once a category is removed, the template will not be associated with any categories, and it will be listed under "All Categories".
Path Parameters
category_idstring | Mandatory The template category ID |
Request Body Parameters
idstring | Mandatory The template ID |
resource_idstring | Mandatory The template ID |
Example Request
DELETE https://www.zohoapis.com/workdrive/api/v1/category/{category_id}/relationships/files
{ data: [ { attributes: { resource_id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2" }, id: "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2", type: "files" }, { attributes: { resource_id: "ly9zm3c10f18ca7e3422db10f5b335d33b0cc" }, id: "ly9zm3c10f18ca7e3422db10f5b335d33b0cc", type: "files" } ] }
Example Response
204: No Content