Tool | Description |
Abort_Workflow_For_A_File_Folder | Aborts an active workflow instance. Use this API when you want to terminate a workflow that is currently in progress. Once aborted, the instance cannot be resumed. |
Add_Member_In_Group | Adds group members to a specific group and returns the created member details. |
Add_Resource_Labels | Adds the specified label to one or more files or folders. |
Allow_User_Document_Conversion | Enables or disables automatic file conversion for the specified team member’s private folder (My Folders), allowing uploaded files to be edited in Zoho’s native document formats. |
Breadcrumbs_Of_File | Fetches the location and folder hierarchy of a file or folder. |
Copy_Multiple_files_folders | Supports Copy Multiple Files/Folders and Copy File/Folder. |
Create_Comments | Supports Create Reply and Create Comment. |
Create_Custom_Field | This API helps in creating a custom field within a data template. |
Create_Customized_Folder | Creates a new folder with custom attributes and settings applied. |
Create_Data_Template | Creates a new data template for the specified team. |
Create_External_Share | Supports Create External Share Custom Link and Create External Share Download Link. |
Create_Files_Folders_Share | Supports Generate Embed Code for a Files/Folders, Share Files/Folders to Group Members, Share Files/Folders to everyone on the Internet, Share Files/Folders with Team and Share Files/Folders to Individual Team Members. |
Create_Folder | Creates a new folder in the specified parent folder. |
Create_Group | Creates a new group within the specified team or organization. |
Create_Label | Creates a new label for the specified user context. |
Create_Link_File | Lets you save web URLs and organize frequently used files and folders in one central location for easy access. |
Create_Multiple_custommetadata | Supports Associate Multiple Files/Folders to Data Template and Associate File/Folder to Data Template. |
Create_New_File | This API enables the creation of Zoho-formatted files, including documents using Zoho Writer, spreadsheets using Zoho Sheet, and presentations using Zoho Show. |
Create_Team_Folder | Creates a new team folder in the specified parent location. |
Create_Team_Folder_Members | Supports Add Members To Team Folder and Add Groups to Team Folder. |
Create_Template_Category | Creates a new template category in the specified template library. |
Create_Zip_File | Compresses multiple files/folders into a ZIP file and saves it to the specified destination folder. |
Create_collections | Supports Create External Collection and Create Internal Collection. |
Delete_Collection | Permanently deletes the specified collection. |
Delete_Comment | Deletes an existing comment or reply. |
Delete_Custom_Field | Deletes the specified custom field from its data template. |
Delete_Data_Template | Deletes the specified data template. |
Delete_Group | Deletes a group and removes all associated members. |
Delete_Label | Deletes the specified label. |
Delete_Member | Removes a member from the specified group. |
Delete_Permission | Removes access for a shared file or folder. |
Delete_Shared_Link | Revokes an existing external share link for a resource. |
Delete_Team_Folder_Member | Removes the specified user or group from the team folder collaboration list. |
Delete_Teamfolder | Deletes the specified team folder and updates related workspace state. |
Delete_Version | Deletes a specific version of a file. Version ID is created when a user creates a new version of the file. |
Disassociate_Files_Folders_From_Data_Template | Removes an existing file/folder and data template association. |
Download_Progress | Uses the WMS key generated from the Download Multiple Files/Folders as ZIP API to fetch the ZIP download progress. |
Download_Server_File | Downloads file content in binary format using a common API for all file types. |
Download_Server_File_Version | Downloads a specific version of a file in binary format. |
Empty_My_Folder_Trash | Permanently removes all items from the trash of the specified My Folders space. |
Empty_Trash | Permanently removes all items from the trash of the specified team folder. |
Favorite_Files | Returns a list of files marked as favorites by the specified team member. |
Fetch_Category_Files_List | Retrieves the list of template files under the specified template category. |
Fetch_Files_Folders | Supports Get File/Folder Info and Get File Thumbnail URL. |
Fetch_Libraries_Info | Retrieves the details of a specific template library using its library ID. |
Fetch_Library_Categories_List | Retrieves the list of template categories available in the specified template library. |
Fetch_Library_Files_List | Retrieves the list of template files from the specified template library based on the provided filters. |
Fetch_Library_Permissions | Retrieves the sharing permissions configured for a specific template library. |
Fetch_Public_Libraries | Retrieves public template libraries based on the requested filter criteria. |
Fetch_Team_Libraries | Retrieves template library details for the specified team. |
Fetch_User_Libraries | Retrieves template library details for the specified team member. |
File_Property | Fetches additional file properties. |
File_Query | Query uploaded file content with Zia and get contextual answers from the file data. On the first request for a file, Zia starts indexing before answers can be generated. Indexing time depends on file size and content. Track progress using status in the API response: 1 = Indexing completed and answers are ready, 2 = Indexing in progress, >=3 = Indexing failed due to an error. |
Generate_File_Summary | Generates an AI-based summary for the specified file. |
Get_Actions_For_A_Transition | Fetches actions available for a workflow transition. |
Get_All_Team_Folders | Returns all team folders in the specified team with optional type filtering and pagination. |
Get_All_Teams_Of_User | Fetches all teams associated with a user. |
Get_Collaboration_Info | Returns collaboration details for the given permission ID. |
Get_Collection_Info | Retrieves the details of a specific collection. |
Get_Comment_Info | Retrieves detailed information about a specific comment. |
Get_Comments | Fetches all comments for a file. |
Get_Current_Team_User | Returns the current authenticated user’s membership details for the specified team. |
Get_DT_Assoc_With_File_Folder | Fetches all data templates linked to a file or folder. |
Get_During_Actions_For_An_Instance_Transition | Retrieves the during-actions configured for the specified transition in a workflow instance. |
Get_File_List | Lists all files and folders inside a specified folder. |
Get_File_Preview | Retrieves preview metadata of a file, including URLs and size. |
Get_File_Statistics | Fetches detailed access stats of a file or folder, including user activity like views and downloads. |
Get_File_Summary | Returns the summary status of a specified file (available, generating, or not created). |
Get_Group_Info | Retrieves detailed information about a specific group. |
Get_Group_Member_Info | Retrieves detailed information about a specific group member. |
Get_Group_Members | Retrieves a list of all members in a specific group. |
Get_Label | Retrieves the details of a specific label. |
Get_Labels | Retrieves all labels associated with the specified team member. |
Get_Link_Info | Retrieves detailed information for a specific external share link. |
Get_List_Of_All_Collection_Links | Returns a list of all collection links for the specified team. |
Get_List_Of_All_Collection_Submissions | This API fetches all data submissions made through a collection link. |
Get_List_Of_All_The_Submitted_Files | This API fetches the list of all files submitted by a user using a given link. |
Get_List_Of_Custom_Fields_Of_Data_Template | Retrieves the list of custom fields for the specified data template. |
Get_List_Of_Data_Templates_In_A_Team | Returns data templates available in the specified team with support for filtering, sorting, search, and pagination. |
Get_List_Of_Recent_Changes | Returns the list of recent changes using the provided page token. |
Get_List_Of_Workflows_In_A_Team | Retrieves the list of workflows configured for the specified team. |
Get_Member_Info | Returns profile and role information for the specified team member, identified by their unique team-member-id. |
Get_My_Draft_Files | Returns draft files created by the current user in the specified team folder. |
Get_My_Folder_Id | Returns the My Folders ID for the specified team member. |
Get_Shared_Links | Fetches all external share links of a file or folder. |
Get_Shared_Users | Fetches all shared users of a file or folder. |
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 up to the last 31 days. |
Get_Team_Folder_Files | Returns files and folders in the specified team folder with filtering, sorting, field selection, and pagination support. |
Get_Team_Folder_Folders | Returns subfolders available within the specified team folder with pagination and sorting support. |
Get_Team_Folder_Links | Returns shared links created for resources in the specified team folder, with type filtering and pagination support. |
Get_Team_Folder_Setting | Retrieves the current settings for the specified team folder, including external sharing, file conversion, viewer download permissions, and device access configurations. |
Get_Team_Folder_Shared_Users | Returns members and groups shared to the specified team folder, with support for filters, search, and pagination. |
Get_Team_Folders_Info | Returns detailed metadata for the specified team folder, including sharing settings, workspace attributes, and current configuration status. |
Get_Team_Info | Returns profile and configuration details for the specified team, including name, description, member count, and sharing settings. |
Get_Team_Setting | Retrieves the administrator-level settings for the specified team, including permissions, sharing policies, storage restrictions, and feature configurations. |
Get_Team_Users | Returns members of the specified team with optional filters and search support. |
Get_Template_Category_Info | Retrieves information for a specific template category using the category ID. |
Get_Trashed_Files | Returns trashed files from the specified team folder for administrators with trash access. |
Get_Unread_Files | Returns unread files for the specified team folder with optional resource-type filtering. |
Get_User_Collaborators | Returns the list of users and groups the specified team member has shared files or folders with. |
Get_User_Groups | Returns all groups the specified team member belongs to within the team. |
Get_User_Info | Get current user details. |
Get_Users_For_An_Instance_Transition | Retrieves the list of pending and completed users for a specific transition within a workflow instance. Use this API to identify assignees or approvers for the selected transition. |
Get_Version | Retrieves all available versions of a file. |
Get_Workflow_Instance | Retrieves the complete details of a specific workflow instance, including its current state, associated transitions, and metadata. |
Get_Workflow_Instances_For_A_File_Folder | Lists all workflow instances associated with a specific file or folder. Use this API to check workflows started on the resource, along with their current statuses. |
Get_Workflow_Instances_For_A_User | Retrieves all workflow instances that were either initiated by a specific user or assigned to them. Use this API to track workflows a user created, workflows awaiting their action, and to filter instances by execution type, status, resource type, or initiation time. |
Get_Workflow_Instances_For_A_Workflow | Retrieves all workflow instances created using a specific workflow. Use this API to track the progress, status, and lifecycle of instances originating from that workflow, with support for time-based and state-based filtering. |
Import_To_Native | This API converts supported non-Zoho files into Zoho Office formats, such as Writer, Sheet, and Show. |
Invite_New_Users | Invites one or more users to join the team by email address. |
Labeled_Files | Returns a list of labeled files for the specified team member. |
List_Team_Groups | Returns all groups belonging to the specified team. Supports filtering by group type and pagination. |
Multi_Download | Compresses multiple files/folders as a ZIP and returns a WMS key to track the ZIP metadata. |
My_Folder_Files | This API retrieves files from your My Folders. |
My_Folder_Links | Returns a list of shared links for the specified My Folders resource. |
My_Trashed_Files | Returns a list of trashed files in the specified My Folders resource. |
Perform_Transition_For_A_Workflow_Instance | Performs the specified transition for the given workflow instance. |
Recent_Files | Returns a list of recently accessed files for the specified team member. |
Remove_Resource_Labels | Removes the specified label from one or more files or folders. |
Remove_Template_Category | Removes the specified template files from the given template category. |
Restore_To_Version | Restores a selected file version as the latest top version. |
Save_Resource_As_Template | Saves a file as a reusable template in the specified template library. |
Search_Records | Supports Search in My Folders, Search across Team Folder, Search across Folder, Search across Team, Search based on Data Template and Search in Shared with Me. |
Shared_With_Me_Files | The Shared with me tab displays all files that are shared with the user by other team members. |
Shared_With_Me_Folders | Returns a list of folders shared with the specified team member. |
Start_Workflow_For_A_File_Folder | Starts a workflow instance for the specified file or folder resource. |
Sub_Folders | This API retrieves folders from your My Folders. |
Suggested_Files | Returns a list of file suggestions for the specified team member. |
Un_Zip_File | Extracts ZIP content to a specified folder in WorkDrive. |
Update_Comments | Supports Resolve Comment, Edit Comment and Reopen Comment. |
Update_Custom_Field | Updates an existing custom field’s definition and properties. |
Update_External_Share | Supports Change Download Link Settings, Change Expiration Settings and Change Password Link Settings. |
Update_Files_Folders | Supports Move File/Folder, Remove a File from the Index View, Rename File/Folder, Permanent Delete File/Folder, Mark File/Folder as Favorites, Remove File/Folder from Favorites, Restore File/Folder, Move File/Folder to Trash, Enable Editing for File, Check out File, Check in File, Mark File as Final, Add a File to the Index View, Update Link file and Mark File as Ready. |
Update_Files_Folders_Share | Supports Update File/Folder Share Permissions and Update File/Folder Share Expiration. |
Update_Folder_Customization | Supports Customize an existing folder and Remove Folder Customization. |
Update_Groups | Supports Rename Group and Update Group Description. |
Update_Labels | Supports Change Label Color and Rename Label. |
Update_Library_User_View_Preference | Updates the user-specific view preference settings for the specified template library. |
Update_Member_Role | Updates the role of an existing group member. |
Update_Multiple_Follow_Updates | Supports Follow File/Folder and Unfollow File/Folder. |
Update_Multiple_files_folders | Supports Move Multiple Files/Folders to Trash, Mark Multiple Files/Folders as Favorites, Move Multiple Files/Folders, Remove Multiple Files/Folders from Favorites, Restore Multiple Files/Folders and Permanent Delete Multiple Files/Folders. |
Update_Org_Template_Admin_Role | Assigns or removes template admin privileges for the specified team member. |
Update_Team_Folder | Supports Pin Team Folder, UnArchive Team Folder, Change Team Folder Description, Change Team Folder Name, Archive Team Folder and Unpin Team Folder. |
Update_Team_Folder_Member | Updates the access role of a shared member in the specified team folder. |
Update_Teams | Supports Change Team Name, Change Team Description and Change Preferred Team. |
Update_Template_Category | Associates the specified template files with the given template category. |
Update_Values_Of_Associated_Files_Folders | Updates custom metadata values for an existing file/folder and data template association. |
Update_category | Supports Rename Category and Delete Category. |
Update_collections | Supports Convert Internal Collection into External Collection, Disable Collection, Update Collection Link Settings, Enable Collection and Convert External Collection into Internal Collection. |
Update_datatemplates | Supports Change Data Template Description, Enable/Disable Data Template and Rename Data Template. |
Update_settings | Supports Enable File Conversion, Allow Viewer to Download and Enable External Sharing. |
Update_users | Supports Delete Team Member, Suspend Team Member and Change Team Member’s role. |
Upload_File | Uploads a text-format file only to a team folder or folder in WorkDrive. |
Upload_New_Version | Uploads a new version of an existing text-format file only. |
Upload_Status | Use this API to check whether a stream upload is in progress or completed, and to fetch proper upload error responses using the upload-id value. |
Zip_Progress_File | Uses the WMS key returned from the Create Multiple Files/Folders as ZIP API to fetch the metadata of the compressed ZIP file. |