# Zoho WorkDrive Integration via LowCodeAPI
## Overview
File storage
## Base Endpoint
```
https://api.lowcodeapi.com/zohoworkdrive/
```
## Authentication
LowCodeAPI handles authentication automatically. You only need to:
1. **Sign up** at [Zoho WorkDrive](https://www.zoho.com/workdrive)
2. **Get your credentials** from [credential page](https://accounts.zoho.com/developerconsole)
3. **Connect your account** in LowCodeAPI dashboard
4. **Use your `api_token`** in all requests
**Auth Type**: OAUTH2.0
## API Categories
- **Chunk Upload** - 5 endpoints
- **Collect Files** - 7 endpoints
- **Comments** - 4 endpoints
- **Data Templates and Custom Fields** - 10 endpoints
- **External Sharing** - 4 endpoints
- **File Version** - 2 endpoints
- **File/Folder Sharing** - 4 endpoints
- **Files/Folders** - 22 endpoints
- **Folders** - 2 endpoints
- **Follow Updates** - 1 endpoints
- **Get Recent Changes** - 2 endpoints
- **Group Members** - 4 endpoints
- **Groups** - 5 endpoints
- **Labels** - 7 endpoints
- **My Folders Files** - 6 endpoints
- **Search** - 1 endpoints
- **Team Folder** - 14 endpoints
- **Team Folder Members** - 3 endpoints
- **Team Member Files** - 5 endpoints
- **Team Members** - 4 endpoints
- **Teams** - 8 endpoints
- **Templates** - 16 endpoints
- **Users** - 2 endpoints
## Common Endpoints
### Category: Chunk Upload
#### Create Session (Normal Upload)
**Method**: `POST` | **LowCodeAPI Path**: `/workdrive/api/v1/uploadsession/create`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/uploadsession/create?api_token={api_token}
```
**Description**: This API is used to upload a new file to your WorkDrive account
**Request Body**:
```json
{
"size": "<string>",
"file_name": "<string>",
"parent_id": "<string>"
}
```
---
#### Create Session for Revision Upload
**Method**: `POST` | **LowCodeAPI Path**: `/workdrive/api/v1/uploadsession/resource_id/create`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/uploadsession/resource_id/create?api_token={api_token}
```
**Description**: This API is used to upload a file as the top version to an existing file in your WorkDrive account
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`resource_id` | string | Yes | Unique id of the resource |
**Request Body**:
```json
{
"size": "<string>"
}
```
---
#### Commit Session (Normal Upload)
**Method**: `POST` | **LowCodeAPI Path**: `/workdrive/api/v1/uploadsession/commit`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/uploadsession/commit?api_token={api_token}
```
**Description**: Once all chunks are uploaded, user can use the commit API to complete the session and create/update the file
**Request Body**:
```json
{
"upload_id": "<string>",
"parent_id": "<string>"
}
```
---
#### Commit Session for Revision Upload
**Method**: `POST` | **LowCodeAPI Path**: `/workdrive/api/v1/uploadsession/resource_id/commit`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/uploadsession/resource_id/commit?api_token={api_token}
```
**Description**: 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
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`resource_id` | string | Yes | Unique id of the resource |
**Request Body**:
```json
{
"upload_id": "<string>"
}
```
---
#### Upload Session Progress
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/uploadsession`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/uploadsession?upload_id={upload_id}&api_token={api_token}
```
**Description**: A user can use this API to get the status of the chunk upload session
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`upload_id` | string | Yes | Upload ID from the Create Session API |
---
### Category: Collect Files
#### Get Collection Info
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/collections/collection_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/collections/collection_id?api_token={api_token}
```
**Description**: This API fetches information about a collection
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`collection_id` | string | Yes | A unique ID that represents a collection. |
---
#### Get list of all Submissions
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/collections/collection_id/submissions`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/collections/collection_id/submissions?api_token={api_token}
```
**Description**: This API fetches all data submissions made through a collection link
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`collection_id` | string | Yes | A unique ID that represents a collection. |
---
#### Get list of all Collection links
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/teams/team_id/collections`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/teams/team_id/collections?api_token={api_token}
```
**Description**: This API fetches the lists of all collection links created by the current user in the given organization
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_id` | string | Yes | The unique ID that represents a team |
---
#### Get list of all user submissions
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/submissions/submission_id/files`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/submissions/submission_id/files?api_token={api_token}
```
**Description**: This API fetches the list of all files submitted by a user using a given link
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`submission_id` | string | Yes | A unique ID that represents each user's file submission via a collection link |
---
#### Create Internal Collection
**Method**: `POST` | **LowCodeAPI Path**: `/workdrive/api/v1/collections`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/collections?api_token={api_token}
```
**Description**: This API helps create an internal collection
**Request Body**:
```json
{
"parent_id": "<string>",
"collection_name": "<string>",
"is_external": "<boolean>"
}
```
---
#### Enable Collection
**Method**: `PATCH` | **LowCodeAPI Path**: `/workdrive/api/v1/collections/collection_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/collections/collection_id?api_token={api_token}
```
**Description**: This API helps in enabling a collection
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`collection_id` | string | Yes | A unique ID that represents a collection. |
**Request Body**:
```json
{
"state": "<string>"
}
```
---
#### Delete Collection
**Method**: `DELETE` | **LowCodeAPI Path**: `/workdrive/api/v1/collections/collection_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/collections/collection_id?api_token={api_token}
```
**Description**: This API helps in deleting a specific collection
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`collection_id` | string | Yes | A unique ID that represents a collection. |
---
### Category: Comments
#### Get Comment Info
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/comments/comment_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/comments/comment_id?api_token={api_token}
```
**Description**: This API fetches all available details of the comment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`comment_id` | string | Yes | The unique ID of the comment |
---
#### Create Reply
**Method**: `POST` | **LowCodeAPI Path**: `/workdrive/api/v1/comments`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/comments?api_token={api_token}
```
**Description**: This API adds a reply to an existing comment on a file
**Request Body**:
```json
{
"resource_id": "<string>",
"comment_html": "<string>",
"parent_comment_id": "<string>"
}
```
---
#### Edit Comment
**Method**: `PATCH` | **LowCodeAPI Path**: `/workdrive/api/v1/comments/comment_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/comments/comment_id?api_token={api_token}
```
**Description**: This API updates a specific comment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`comment_id` | string | Yes | The unique ID of the comment |
**Request Body**:
```json
{
"comment_html": "<string>"
}
```
---
#### Delete Comment
**Method**: `DELETE` | **LowCodeAPI Path**: `/workdrive/api/v1/comments/comment_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/comments/comment_id?api_token={api_token}
```
**Description**: This API deletes a specific comment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`comment_id` | string | Yes | The unique ID of the comment |
---
### Category: Data Templates and Custom Fields
#### Create Data Template
**Method**: `POST` | **LowCodeAPI Path**: `/workdrive/api/v1/teams/team_id/datatemplates`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/teams/team_id/datatemplates?api_token={api_token}
```
**Description**: This API creates a new data template
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_id` | string | Yes | A unique ID of the team in which the data template is created |
**Request Body**:
```json
{
"name": "<string>"
}
```
---
#### Enable/Disable Data Template
**Method**: `PATCH` | **LowCodeAPI Path**: `/workdrive/api/v1/datatemplates/data_template_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/datatemplates/data_template_id?api_token={api_token}
```
**Description**: This API helps in enabling or disabling a data template
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`data_template_id` | string | Yes | A unique ID of the data template |
**Request Body**:
```json
{
"status": "<boolean>"
}
```
---
#### Delete Data Template
**Method**: `DELETE` | **LowCodeAPI Path**: `/workdrive/api/v1/datatemplates/data_template_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/datatemplates/data_template_id?api_token={api_token}
```
**Description**: This API deletes a data template
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`data_template_id` | string | Yes | A unique ID of the data template |
---
#### Create Custom Field
**Method**: `POST` | **LowCodeAPI Path**: `/workdrive/api/v1/datatemplates/data_template_id/customfields`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/datatemplates/data_template_id/customfields?api_token={api_token}
```
**Description**: This API helps in creating a custom field within a data template
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`data_template_id` | string | Yes | A unique ID of the data template |
**Request Body**:
```json
{
"display_name": "<string>",
"type": "<string>"
}
```
---
#### Update Custom Field
**Method**: `PATCH` | **LowCodeAPI Path**: `/workdrive/api/v1/customfields/custom_field_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/customfields/custom_field_id?api_token={api_token}
```
**Description**: This API helps in updating custom field data
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`custom_field_id` | string | Yes | A unique ID of the custom field |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Delete Custom Field
**Method**: `DELETE` | **LowCodeAPI Path**: `/workdrive/api/v1/customfields/custom_field_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/customfields/custom_field_id?api_token={api_token}
```
**Description**: This API helps in deleting a custom field
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`custom_field_id` | string | Yes | A unique ID of the custom field |
---
#### Associate Multiple Files/Folders to Data Template
**Method**: `POST` | **LowCodeAPI Path**: `/workdrive/api/v1/custommetadata`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/custommetadata?api_token={api_token}
```
**Description**: This API helps in associating multiple files or folders to a specific data template
**Request Body**:
```json
{
"resource_id": "<string>",
"data_template_id": "<string>",
"custom_data": "<array>"
}
```
---
#### Update Values of Associated Files/Folders
**Method**: `PATCH` | **LowCodeAPI Path**: `/workdrive/api/v1/custommetadata/custommetadata_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/custommetadata/custommetadata_id?api_token={api_token}
```
**Description**: This API helps in editing the custom filed values provided with the associated files and folder
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`custommetadata_id` | string | Yes | A unique ID that represents the association of a file/folder to a data template |
**Request Body**:
```json
{
"custom_data": "<array>"
}
```
---
#### Disassociate Files/Folders from Data Template
**Method**: `DELETE` | **LowCodeAPI Path**: `/workdrive/api/v1/custommetadata/custommetadata_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/custommetadata/custommetadata_id?api_token={api_token}
```
**Description**: This API disassociates a file or folder from a data template
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`custommetadata_id` | string | Yes | A unique ID that represents the association of a file/folder to a data template |
---
#### Get List of Custom Fields
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/datatemplates/data_template_id/customfields`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/datatemplates/data_template_id/customfields?api_token={api_token}
```
**Description**: This API fetches all custom fields created within a data template
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`data_template_id` | string | Yes | A unique ID of the data template |
---
### Category: External Sharing
#### Get External Share Link Info
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/links/link_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/links/link_id?api_token={api_token}
```
**Description**: This API fetches information about an external share link
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`link_id` | string | Yes | The unique ID of the shared link. |
---
#### Create External Share Download Link
**Method**: `POST` | **LowCodeAPI Path**: `/workdrive/api/v1/links`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/links?api_token={api_token}
```
**Description**: This API creates download external share links for files and folders stored in a team folder or my folders
**Request Body**:
```json
{
"resource_id": "<string>",
"link_name": "<string>",
"link_type": "<string>",
"request_user_data": "<boolean>",
"allow_download": "<boolean>"
}
```
---
#### Change Password Link Settings
**Method**: `PATCH` | **LowCodeAPI Path**: `/workdrive/api/v1/links/link_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/links/link_id?api_token={api_token}
```
**Description**: This API helps in changing the password and to enable or disable password protection for the link
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`link_id` | string | Yes | The unique ID of the shared link. |
**Request Body**:
```json
{
"password_text": "<string>"
}
```
---
#### Revoke External Share Link
**Method**: `DELETE` | **LowCodeAPI Path**: `/workdrive/api/v1/links/link_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/links/link_id?api_token={api_token}
```
**Description**: This API deletes a file or folder's external share link
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`link_id` | string | Yes | The unique ID of the shared link. |
---
### Category: File Version
#### Restore as Top Version
**Method**: `POST` | **LowCodeAPI Path**: `/workdrive/api/v1/versions`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/versions?api_token={api_token}
```
**Description**: This API restores a specific version of a file to be the top version of the file
**Request Body**:
```json
{
"resource_id": "<string>",
"revert_to": "<string>"
}
```
---
#### Delete Version
**Method**: `DELETE` | **LowCodeAPI Path**: `/workdrive/api/v1/versions/version_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/versions/version_id?api_token={api_token}
```
**Description**: This API deletes a specific version of a file
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`version_id` | string | Yes | The value of the version to be deleted |
---
### Category: File/Folder Sharing
#### Get File/Folder Collaboration Info
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/permissions/permission_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/permissions/permission_id?api_token={api_token}
```
**Description**: This API returns sharing information about the file or folder
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`permission_id` | string | Yes | The unique ID that represents collaboration |
---
#### Share Files/Folders with Team
**Method**: `POST` | **LowCodeAPI Path**: `/workdrive/api/v1/permissions`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/permissions?api_token={api_token}
```
**Description**: This API will share the file or folders with all team members in a team
**Request Body**:
```json
{
"resource_id": "<string>",
"shared_type": "<string>",
"role_id": "<number>"
}
```
---
#### Update File/Folder Share Permissions
**Method**: `PATCH` | **LowCodeAPI Path**: `/workdrive/api/v1/permissions/permission_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/permissions/permission_id?api_token={api_token}
```
**Description**: This API will update the roles of the users with whom the files need to be shared
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`permission_id` | string | Yes | The unique ID that represents collaboration |
**Request Body**:
```json
{
"role_id": "<number>"
}
```
---
#### Delete File/Folder Share Access
**Method**: `DELETE` | **LowCodeAPI Path**: `/workdrive/api/v1/permissions/permission_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/permissions/permission_id?api_token={api_token}
```
**Description**: This API will stop sharing the file/folder and remove access
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`permission_id` | string | Yes | The unique ID that represents collaboration |
---
### Category: Files/Folders
#### Upload Large File >250MB
**Method**: `POST` | **LowCodeAPI Path**: `/workdrive-api/v1/stream/upload`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive-api/v1/stream/upload?api_token={api_token}
```
**Description**: The API response will only have details of the successfully uploaded files
**Request Body**:
```json
{
"x-filename": "<string>",
"x-parent_id": "<string>",
"upload-id": "<string>",
"x-streammode": "<string>"
}
```
---
#### Upload File
**Method**: `POST` | **LowCodeAPI Path**: `/workdrive/api/v1/upload`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/upload?api_token={api_token}
```
**Description**: This API uploads a file to a destined team folder or folder in WorkDrive
**Request Body**:
```json
{
"parent_id": "<string>",
"content": "<file>"
}
```
---
#### Download File
**Method**: `GET` | **LowCodeAPI Path**: `/v1/workdrive/download/resource_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/v1/workdrive/download/resource_id?version={version}&api_token={api_token}
```
**Description**: This API returns the file content in binary format
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`resource_id` | string | Yes | The unique ID of the file/folder |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`version` | string | No | Version number of the file, if it is not present, the top version content will be downloaded |
---
#### Get File Thumbnail URL
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/files/resource_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/files/resource_id?api_token={api_token}
```
**Description**: This API will return all information about a file, which also includes the thumbnail URL of the file
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`resource_id` | string | Yes | The unique ID of the file/folder |
---
#### Get File Versions
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/files/resource_id/versions`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/files/resource_id/versions?api_token={api_token}
```
**Description**: This API fetches all versions of a file
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`resource_id` | string | Yes | The unique ID of the file/folder |
---
#### Get Preview Meta Data
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/files/resource_id/previewinfo`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/files/resource_id/previewinfo?api_token={api_token}
```
**Description**: This API fetches all metadata required for previewing the file
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`resource_id` | string | Yes | The unique ID of the file/folder |
---
#### Get File/Folder Breadcrumbs
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/files/resource_id/breadcrumbs`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/files/resource_id/breadcrumbs?api_token={api_token}
```
**Description**: 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**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`resource_id` | string | Yes | The unique ID of the file/folder |
---
#### Get File Comments
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/files/resource_id/comments`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/files/resource_id/comments?api_token={api_token}
```
**Description**: This API lists all the comments from a file
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`resource_id` | string | Yes | The unique ID of the file/folder |
---
#### Get File/Folder External Share Links
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/files/resource_id/links`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/files/resource_id/links?filter[type]={filter[type]}&api_token={api_token}
```
**Description**: This API fetches the list of all external share links created for a file/folder
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`resource_id` | string | Yes | The unique ID of the file/folder |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`filter[type]` | string | No | To filter by link type |
---
#### Get Shared Users of File
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/files/resource_id/permissions`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/files/resource_id/permissions?api_token={api_token}
```
**Description**: This API fetches all shared users of a file or folder
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`resource_id` | string | Yes | The unique ID of the file/folder |
---
#### Get File/Folder ResourceProperty
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/resourceproperty/resource_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/resourceproperty/resource_id?api_token={api_token}
```
**Description**: This API will return additional properties of the file
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`resource_id` | string | Yes | The unique ID of the file/folder |
---
#### Get File/Folder statistics
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/files/resource_id/statistics`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/files/resource_id/statistics?api_token={api_token}
```
**Description**: This API fetches you complete access stats of the file or folder
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`resource_id` | string | Yes | The unique ID of the file/folder |
---
#### Download Multiple Files/Folders as ZIP
**Method**: `POST` | **LowCodeAPI Path**: `/workdrive/api/v1/multizip`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/multizip?api_token={api_token}
```
**Description**: This API downloads multiple files/folders in a compressed ZIP format
**Request Body**:
```json
{
"resource_id": "<string>"
}
```
---
#### Multi Download Progress
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/downloadprogress`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/downloadprogress?progressid={progressid}&api_token={api_token}
```
**Description**: 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**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`progressid` | string | Yes | WMS Key which returned from Download Multiple Files/Folders as ZIP |
---
#### Upload Progress
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/uploadprogress`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/uploadprogress?uploadid={uploadid}&api_token={api_token}
```
**Description**: 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
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`uploadid` | string | No | Unique string for processing upload |
---
*Note: Showing 15 of 22 endpoints in this category.*
---
### Category: Folders
#### Create Folder
**Method**: `POST` | **LowCodeAPI Path**: `/workdrive/api/v1/files`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/files?api_token={api_token}
```
**Description**: This API creates a folder in WorkDrive
**Request Body**:
```json
{
"name": "<string>",
"parent_id": "<string>"
}
```
---
#### List Files/Folders inside a Folder
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/files/folder_id/files`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/files/folder_id/files?filter[type]={filter[type]}&filter[externalUpload]={filter[externalUpload]}&filter[extension]={filter[extension]}&page[limit]={page[limit]}&page[offset]={page[offset]}&page[next]={page[next]}&fields[files]={fields[files]}&sort={sort}&api_token={api_token}
```
**Description**: This API lists down all the files and folders present within a folder
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`folder_id` | string | Yes | The unique ID that represents a folder |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`filter[type]` | string | No | To filter by resource type. |
|`filter[externalUpload]` | string | No | Set false to avoid externally uploaded folders. |
|`filter[extension]` | string | No | Filter resources by their file extensions. |
|`page[limit]` | string | No | Limit indicates the number of items to be listed. |
|`page[offset]` | string | No | Offset pagination returns 50 items by default. |
|`page[next]` | string | No | Cursor pagination returns 1000 items by default. |
|`fields[files]` | string | No | Mention the required params to be included in the response attribute. |
|`sort` | string | No | Sorting can be done with these fields: name, kind, shared_time, last_modified, created_time |
---
### Category: Follow Updates
#### Unfollow File/Folder
**Method**: `PATCH` | **LowCodeAPI Path**: `/workdrive/api/v1/files`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/files?api_token={api_token}
```
**Description**: This API will remove follow updates for the file or folder
**Request Body**:
```json
{
"id": "<string>",
"watch_preference": "<string>"
}
```
---
### Category: Get Recent Changes
#### Get Start Token
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/changes/resource_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/changes/resource_id?page[token]={page[token]}&page[limit]={page[limit]}&api_token={api_token}
```
**Description**: This API is used to generate the starting point token, which is required to check the changes in the WorkDrive account
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`resource_id` | string | Yes | The unique ID of My Folders, Team Folder, or any sub folder |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`page[token]` | string | Yes | Set the token value in one of the below methods: latest (to check changes from current time), Milliseconds, Date format (yyyy-mm-dd), Date and time format (yyyy-mm-dd hh:mm:ss) |
|`page[limit]` | string | No | Page limit refers to the total page results you need to view using the API response. |
---
#### Get list of Recent Changes
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/changes`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/changes?page[next]={page[next]}&api_token={api_token}
```
**Description**: This API provides a list of all files and folders that were modified or added during the given time
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`page[next]` | string | Yes | Use the page token received from the above API |
---
### Category: Group Members
#### Get Group Member Info
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/groupmembers/group_member_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/groupmembers/group_member_id?api_token={api_token}
```
**Description**: This API fetches the required information about a group member
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`group_member_id` | string | Yes | The unique ID of the group member. |
---
#### Add Multiple Members to Group
**Method**: `POST` | **LowCodeAPI Path**: `/workdrive/api/v1/groupmembers`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/groupmembers?api_token={api_token}
```
**Description**: This API helps in adding multiple new members to a WorkDrive group
**Request Body**:
```json
{
"member_zuid": "<string>",
"group_id": "<string>",
"role_id": "<number>"
}
```
---
#### Update Group Member Role
**Method**: `PATCH` | **LowCodeAPI Path**: `/workdrive/api/v1/groupmembers/group_member_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/groupmembers/group_member_id?api_token={api_token}
```
**Description**: This API helps in changing the role of a group member
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`group_member_id` | string | Yes | The unique ID of the group member. |
**Request Body**:
```json
{
"role_id": "<number>"
}
```
---
#### Remove Group Member
**Method**: `DELETE` | **LowCodeAPI Path**: `/workdrive/api/v1/groupmembers/group_member_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/groupmembers/group_member_id?api_token={api_token}
```
**Description**: This API removes members from a group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`group_member_id` | string | Yes | The unique ID of the group member, who will be removed from the group. |
---
### Category: Groups
#### Get List of Group Members
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/groups/group_id/groupmembers`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/groups/group_id/groupmembers?api_token={api_token}
```
**Description**: This API lists all members in a group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`group_id` | string | Yes | The unique ID of the group. |
---
#### Get Group Info
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/groups/group_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/groups/group_id?api_token={api_token}
```
**Description**: This API fetches information about a group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`group_id` | string | Yes | The unique ID of the group. |
---
#### Create Group
**Method**: `POST` | **LowCodeAPI Path**: `/workdrive/api/v1/groups`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/groups?api_token={api_token}
```
**Description**: This API creates a new user group in a WorkDrive team
**Request Body**:
```json
{
"name": "<string>",
"parent_id": "<string>",
"type": "<number>"
}
```
---
#### Update Group Description
**Method**: `PATCH` | **LowCodeAPI Path**: `/workdrive/api/v1/groups/group_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/groups/group_id?api_token={api_token}
```
**Description**: This API helps in changing the description of a group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`group_id` | string | Yes | The unique ID of the group. |
**Request Body**:
```json
{
"description": "<string>"
}
```
---
#### Delete Group
**Method**: `DELETE` | **LowCodeAPI Path**: `/workdrive/api/v1/groups/group_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/groups/group_id?api_token={api_token}
```
**Description**: This API deletes a group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`group_id` | string | Yes | The unique ID of the group. |
---
### Category: Labels
#### Get Label
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/labels/label_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/labels/label_id?api_token={api_token}
```
**Description**: This API fetches the details of a Label
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`label_id` | string | Yes | The unique ID of a label. |
---
#### Get All Labels of the User
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/users/team_member_id/labels`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/users/team_member_id/labels?api_token={api_token}
```
**Description**: This API fetches all the labels created by the user
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_member_id` | string | Yes | The unique ID of the team member that is created when a member is added into a team. |
---
#### Create Label
**Method**: `POST` | **LowCodeAPI Path**: `/workdrive/api/v1/labels`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/labels?api_token={api_token}
```
**Description**: This API helps in creating a label
**Request Body**:
```json
{
"name": "<string>",
"color": "<string>",
"user_id": "<string>"
}
```
---
#### Change Label Color
**Method**: `PATCH` | **LowCodeAPI Path**: `/workdrive/api/v1/labels/label_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/labels/label_id?api_token={api_token}
```
**Description**: This API helps in changing the label color
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`label_id` | string | Yes | The unique ID of a label. |
**Request Body**:
```json
{
"color": "<string>"
}
```
---
#### Add Label to File/Folder
**Method**: `POST` | **LowCodeAPI Path**: `/workdrive/api/v1/labels/label_id/relationships/files`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/labels/label_id/relationships/files?api_token={api_token}
```
**Description**: This API helps in adding labels to the required files and folders
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`label_id` | string | Yes | The unique ID of a label. |
**Request Body**:
```json
{
"id": "<string>",
"resource_id": "<string>"
}
```
---
#### Remove Label from File/Folder
**Method**: `DELETE` | **LowCodeAPI Path**: `/workdrive/api/v1/labels/label_id/relationships/files`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/labels/label_id/relationships/files?api_token={api_token}
```
**Description**: This API helps in removing labels from files and folders
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`label_id` | string | Yes | The unique ID of a label. |
---
#### Delete Label
**Method**: `DELETE` | **LowCodeAPI Path**: `/workdrive/api/v1/labels/label_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/labels/label_id?api_token={api_token}
```
**Description**: This API helps in deleting a label
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`label_id` | string | Yes | The unique ID of a label. |
---
### Category: My Folders Files
#### Get My Folders Id
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/users/team_member_id/privatespace`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/users/team_member_id/privatespace?api_token={api_token}
```
**Description**: This API fetches the ID of the team member's my folders
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_member_id` | string | Yes | The unique ID that represents the team member |
---
#### Get My Folders Links
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/privatespace/myfolder_id/links`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/privatespace/myfolder_id/links?filter[type]={filter[type]}&api_token={api_token}
```
**Description**: This API fetches the list of the external share links created for the files/folders inside the team member's my folders
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`myfolder_id` | string | Yes | The unique ID that represents team member's my folders |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`filter[type]` | string | No | To filter by link type |
---
#### Get Files in My Folders
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/privatespace/myfolder_id/files`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/privatespace/myfolder_id/files?filter[type]={filter[type]}&filter[extension]={filter[extension]}&page[limit]={page[limit]}&page[offset]={page[offset]}&page[next]={page[next]}&fields[files]={fields[files]}&sort={sort}&api_token={api_token}
```
**Description**: This API fetches files from the team member's my folders
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`myfolder_id` | string | Yes | The unique ID that represents team member's my folders |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`filter[type]` | string | No | To filter by resource type |
|`filter[extension]` | string | No | Filter resources by their file extensions |
|`page[limit]` | string | No | Limit indicates the number of items to be listed |
|`page[offset]` | string | No | Offset indicates from where the listing should start |
|`page[next]` | string | No | Cursor pagination returns 1000 items by default. |
|`fields[files]` | string | No | Mention the required params to be included in the response attribute |
|`sort` | string | No | Sorting can be done with these fields |
---
#### Get Folders in My Folders
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/privatespace/myfolder_id/folders`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/privatespace/myfolder_id/folders?page[limit]={page[limit]}&page[offset]={page[offset]}&sort={sort}&api_token={api_token}
```
**Description**: This API fetches the list of folders inside the team member's my folders
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`myfolder_id` | string | Yes | The unique ID that represents team member's my folders |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`page[limit]` | string | No | Limit indicates the number of items to be listed |
|`page[offset]` | string | No | Offset indicates from where the listing should start |
|`sort` | string | No | Sorting can be done with these fields |
---
#### Get Trashed Files in My Folders
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/privatespace/myfolder_id/trashedfiles`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/privatespace/myfolder_id/trashedfiles?page[limit]={page[limit]}&page[offset]={page[offset]}&sort={sort}&api_token={api_token}
```
**Description**: This API fetches files from the trash folder in the team member's my folders
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`myfolder_id` | string | Yes | The unique ID that represents team member's my folders |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`page[limit]` | string | No | Limit indicates the number of items to be listed |
|`page[offset]` | string | No | Offset indicates from where the listing should start |
|`sort` | string | No | Sorting can be done with these fields |
---
#### Enable Document Conversion
**Method**: `PATCH` | **LowCodeAPI Path**: `/workdrive/api/v1/settings/myfolder_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/settings/myfolder_id?api_token={api_token}
```
**Description**: This API will help automatically convert all files to Zoho WorkDrive's format while uploading to the user's my folders
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`myfolder_id` | string | Yes | The unique ID that represents team member's my folders |
**Request Body**:
```json
{
"is_document_conversion": "<boolean>"
}
```
---
### Category: Search
#### Search based on Data Template
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/teams/team_id/records`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/teams/team_id/records?search[all|name|content]={search[all|name|content]}&filter[datatemplate]={filter[datatemplate]}&filter[customFields]={filter[customFields]}&filter[type]={filter[type]}&filter[date]={filter[date]}&filter[fromDate]={filter[fromDate]}&filter[toDate]={filter[toDate]}&filter[status]={filter[status]}&filter[creator]={filter[creator]}&page[limit]={page[limit]}&page[offset]={page[offset]}&sort={sort}&api_token={api_token}
```
**Description**: This API searches for data based on data templates associated with the files
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_id` | string | Yes | The unique ID of the team |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`search[all|name|content]` | string | Yes | all Search using all the criteria. |
|`filter[datatemplate]` | string | Yes | To search resources associated to a specific date template |
|`filter[customFields]` | string | No | To filter files and folders by adding custom field criteria. |
|`filter[type]` | string | No | To Search specific file type. |
|`filter[date]` | string | No | To search resource by predefined date filter. |
|`filter[fromDate]` | string | No | To search from a particular Date. |
|`filter[toDate]` | string | No | To search till a particular Date. |
|`filter[status]` | string | No | To search resources by its current state. |
|`filter[creator]` | string | No | To search resources by its creator. |
|`page[limit]` | string | No | Limit indicates the number of items to be listed. |
|`page[offset]` | string | No | Offset indicates from where the listing should start. |
|`sort` | string | No | Sorting can be done |
---
### Category: Team Folder
#### Empty Team Folder Trash
**Method**: `POST` | **LowCodeAPI Path**: `/workdrive/api/v1/actions`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/actions?api_token={api_token}
```
**Description**: This API clears the files and folders in the team folder trash permanently
**Request Body**:
```json
{
"id": "<string>",
"parent_id": "<string>"
}
```
---
#### Get Team Folder Info
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/teamfolders/teamfolder_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/teamfolders/teamfolder_id?api_token={api_token}
```
**Description**: This API fetches all the information about a team folder
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamfolder_id` | string | Yes | The unique ID of a team folder |
---
#### Get Team Folder Members
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/teamfolders/teamfolder_id/members`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/teamfolders/teamfolder_id/members?api_token={api_token}
```
**Description**: This API fetches all members who are part of a team folder
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamfolder_id` | string | Yes | The unique ID of a team folder |
---
#### Get Team Folder Files and Folders
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/teamfolders/teamfolder_id/files`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/teamfolders/teamfolder_id/files?filter[type]={filter[type]}&filter[extension]={filter[extension]}&page[limit]={page[limit]}&page[offset]={page[offset]}&page[next]={page[next]}&fields[files]={fields[files]}&sort={sort}&api_token={api_token}
```
**Description**: This API fetches all the files and folders in a team folder
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamfolder_id` | string | Yes | The unique ID of a team folder |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`filter[type]` | string | No | To filter by resource type. |
|`filter[extension]` | string | No | Filter resources by their file extensions. |
|`page[limit]` | string | No | Limit indicates the number of items to be listed. |
|`page[offset]` | string | No | Offset indicates from where the listing should start |
|`page[next]` | string | No | Cursor pagination returns 1000 items by default. |
|`fields[files]` | string | No | Mention the required params to be included in the response attribute. |
|`sort` | string | No | Sorting can be done with these fields: name, kind, shared_time, last_modified, created_time. |
---
#### Get list of Sub Folders
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/teamfolders/teamfolder_id/folders`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/teamfolders/teamfolder_id/folders?page[limit]={page[limit]}&page[offset]={page[offset]}&sort={sort}&api_token={api_token}
```
**Description**: This API fetches the list of sub folders in a team folder
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamfolder_id` | string | Yes | The unique ID of a team folder |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`page[limit]` | string | No | Limit indicates the number of items to be listed. |
|`page[offset]` | string | No | Offset indicates from where the listing should start. |
|`sort` | string | No | Sorting can be done with these fields: name, kind, shared_time, last_modified, created_time |
---
#### Get Team Folder Links
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/teamfolders/teamfolder_id/links`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/teamfolders/teamfolder_id/links?filter[type]={filter[type]}&page[limit]={page[limit]}&page[offset]={page[offset]}&api_token={api_token}
```
**Description**: This API fetches all share links (i.e., external share links, download links, and embed codes) created in a team folder
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamfolder_id` | string | Yes | The unique ID of a team folder |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`filter[type]` | string | No | To filter by link type. |
|`page[limit]` | string | No | Limit indicates the number of items to be listed. |
|`page[offset]` | string | No | Offset indicates from where the listing should start. |
---
#### Get Team Folder Settings
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/teamfolders/teamfolder_id/settings`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/teamfolders/teamfolder_id/settings?api_token={api_token}
```
**Description**: This API fetches the settings of a team folder
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamfolder_id` | string | Yes | The unique ID of a team folder |
---
#### Get Team Folder MyDraft Files
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/teamfolders/teamfolder_id/mydrafts`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/teamfolders/teamfolder_id/mydrafts?filter[type]={filter[type]}&page[limit]={page[limit]}&page[offset]={page[offset]}&sort={sort}&api_token={api_token}
```
**Description**: This API fetches the list of all of the draft files in a team folder
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamfolder_id` | string | Yes | The unique ID of a team folder |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`filter[type]` | string | No | To filter by resource type. |
|`page[limit]` | string | No | Limit indicates the number of items to be listed. |
|`page[offset]` | string | No | Offset indicates from where the listing should start. |
|`sort` | string | No | Sorting can be done with these fields: name, kind, shared_time, last_modified, created_time |
---
#### Get Team Folder Unread Files
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/teamfolders/teamfolder_id/unreadfiles`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/teamfolders/teamfolder_id/unreadfiles?filter[type]={filter[type]}&api_token={api_token}
```
**Description**: This API fetches all the unread files in a team folder
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamfolder_id` | string | Yes | The unique ID of a team folder |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`filter[type]` | string | No | To filter by resource type. |
---
#### Get Team Folder Trashed Files
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/teamfolders/teamfolder_id/trashedfiles`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/teamfolders/teamfolder_id/trashedfiles?filter[type]={filter[type]}&page[limit]={page[limit]}&page[offset]={page[offset]}&sort={sort}&api_token={api_token}
```
**Description**: This API fetches all the files in a team folder's Trash
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamfolder_id` | string | Yes | The unique ID of a team folder |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`filter[type]` | string | No | To filter by resource type. |
|`page[limit]` | string | No | Limit indicates the number of items to be listed. |
|`page[offset]` | string | No | Offset indicates from where the listing should start. |
|`sort` | string | No | Sorting can be done with these fields: name, kind, shared_time, last_modified, created_time |
---
#### Create Team Folder
**Method**: `POST` | **LowCodeAPI Path**: `/workdrive/api/v1/teamfolders`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/teamfolders?api_token={api_token}
```
**Description**: This API creates a new team folder in a team
**Request Body**:
```json
{
"name": "<string>",
"parent_id": "<string>",
"is_public_within_team": "<boolean>"
}
```
---
#### Change Team Folder Name
**Method**: `PATCH` | **LowCodeAPI Path**: `/workdrive/api/v1/teamfolders/teamfolder_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/teamfolders/teamfolder_id?api_token={api_token}
```
**Description**: This API changes a team folder's name
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamfolder_id` | string | Yes | The unique ID of a team folder |
**Request Body**:
```json
{
"name": "<string>"
}
```
---
#### Enable Document Conversion
**Method**: `PATCH` | **LowCodeAPI Path**: `/workdrive/api/v1/settings/teamfolder_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/settings/teamfolder_id?api_token={api_token}
```
**Description**: This API will help in enabling automatic conversion of all files to Zoho WorkDrive's format on upload
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamfolder_id` | string | Yes | The unique ID of a team folder |
**Request Body**:
```json
{
"is_document_conversion": "<boolean>"
}
```
---
#### Delete Team Folder
**Method**: `DELETE` | **LowCodeAPI Path**: `/workdrive/api/v1/teamfolders/teamfolder_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/teamfolders/teamfolder_id?api_token={api_token}
```
**Description**: This API deletes a team folder
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamfolder_id` | string | Yes | The unique ID of a team folder |
---
### Category: Team Folder Members
#### Add Groups to Team Folder
**Method**: `POST` | **LowCodeAPI Path**: `/workdrive/api/v1/members`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/members?api_token={api_token}
```
**Description**: This API will add a WorkDrive Group to the team folder
**Request Body**:
```json
{
"resource_id": "<string>",
"shared_type": "<string>",
"share_to": "<string>"
}
```
---
#### Update Member Role in Team Folder
**Method**: `PATCH` | **LowCodeAPI Path**: `/workdrive/api/v1/members/member_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/members/member_id?api_token={api_token}
```
**Description**: This API updates the team folder member's role in a team folder
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`member_id` | string | Yes | The ID that is created when a member is added to a team folder |
**Request Body**:
```json
{
"role_id": "<number>"
}
```
---
#### Delete Member from Team Folder
**Method**: `DELETE` | **LowCodeAPI Path**: `/workdrive/api/v1/members/member_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/members/member_id?api_token={api_token}
```
**Description**: This API deletes members from a team folder
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`member_id` | string | Yes | The ID that is created when a member is added to a team folder |
---
### Category: Team Member Files
#### Get Files in Shared with Me
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/users/team_member_id/incomingfiles`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/users/team_member_id/incomingfiles?filter[type]={filter[type]}&filter[user]={filter[user]}&filter[group]={filter[group]}&page[limit]={page[limit]}&page[offset]={page[offset]}&sort={sort}&api_token={api_token}
```
**Description**: This API fetches the list of files shared to the member by other team members in a team
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_member_id` | string | Yes | The unique ID that represents the team member |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`filter[type]` | string | No | To filter by resource type. |
|`filter[user]` | string | No | To get files shared by a particular user. |
|`filter[group]` | string | No | To get files shared to a particular group in WorkDrive. |
|`page[limit]` | string | No | Limit indicates the number of items to be listed. |
|`page[offset]` | string | No | Offset indicates from where the listing should start. |
|`sort` | string | No | Sorting can be done with these fields: |
---
#### Get Folders in Shared with Me
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/users/team_member_id/incomingfolders`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/users/team_member_id/incomingfolders?page[limit]={page[limit]}&page[offset]={page[offset]}&api_token={api_token}
```
**Description**: This API fetches the list of folders shared to the members by other team members in a team
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_member_id` | string | Yes | The unique ID that represents the team member |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`page[limit]` | string | No | Limit indicates the number of items to be listed. |
|`page[offset]` | string | No | Offset indicates from where the listing should start. |
---
#### Get Recent Files
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/users/team_member_id/recentfiles`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/users/team_member_id/recentfiles?filter[type]={filter[type]}&page[limit]={page[limit]}&page[offset]={page[offset]}&api_token={api_token}
```
**Description**: This API fetches files and folders recently used by this team member
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_member_id` | string | Yes | The unique ID that represents the team member |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`filter[type]` | string | No | To filter by resource type. |
|`page[limit]` | string | No | Limit indicates the number of items to be listed. |
|`page[offset]` | string | No | Offset indicates from where the listing should start. |
---
#### Get Favorited Files
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/users/team_member_id/favoritedfiles`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/users/team_member_id/favoritedfiles?filter[type]={filter[type]}&page[limit]={page[limit]}&page[offset]={page[offset]}&api_token={api_token}
```
**Description**: This API fetches files and folders that are marked as favorite by this team member
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_member_id` | string | Yes | The unique ID that represents the team member |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`filter[type]` | string | No | To filter by resource type. |
|`page[limit]` | string | No | Limit indicates the number of items to be listed. |
|`page[offset]` | string | No | Offset indicates from where the listing should start. |
---
#### Get Labeled Files
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/users/team_member_id/labeledfiles`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/users/team_member_id/labeledfiles?filter[label_id]={filter[label_id]}&filter[type]={filter[type]}&page[limit]={page[limit]}&page[offset]={page[offset]}&sort={sort}&api_token={api_token}
```
**Description**: This API fetches all files and folders associated with a label
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_member_id` | string | Yes | The unique ID that represents the team member |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`filter[label_id]` | string | No | To filter files by a particular label. |
|`filter[type]` | string | No | To filter by resource type. |
|`page[limit]` | string | No | Limit indicates the number of items to be listed. |
|`page[offset]` | string | No | Offset indicates from where the listing should start. |
|`sort` | string | No | Sorting can be done with these fields: name, kind, shared_time, last_modified, created_time. |
---
### Category: Team Members
#### Get Team Member Info
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/users/team_member_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/users/team_member_id?api_token={api_token}
```
**Description**: This API fetches information about a team member
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_member_id` | string | Yes | The unique ID of the team member that is created when a member is added into a team |
---
#### Get Team Member's Groups
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/users/team_member_id/groups`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/users/team_member_id/groups?api_token={api_token}
```
**Description**: This API lists all the groups a specific team member is part of
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_member_id` | string | Yes | The unique ID of the team member that is created when a member is added into a team |
---
#### Get Team Member Collaborators
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/users/team_member_id/collaborators`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/users/team_member_id/collaborators?api_token={api_token}
```
**Description**: This API fetches the list of all team members and groups with whom the user has shared files and folders
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_member_id` | string | Yes | The unique ID of the team member that is created when a member is added into a team |
---
#### Invite New Member to Team
**Method**: `POST` | **LowCodeAPI Path**: `/workdrive/api/v1/users`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/users?api_token={api_token}
```
**Description**: This API is used to invite one or more new members to a team in WorkDrive
**Request Body**:
```json
{
"email_id": "<string>",
"category_id": "<string>",
"role_id": "<number>"
}
```
---
### Category: Teams
#### Get Team Settings
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/teams/team_id/settings`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/teams/team_id/settings?api_token={api_token}
```
**Description**: This API fetches the settings of a specific team
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_id` | string | Yes | The unique ID that represents a team |
---
#### Get Groups in a Team
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/teams/team_id/groups`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/teams/team_id/groups?filter[type]={filter[type]}&page[limit]={page[limit]}&page[offset]={page[offset]}&api_token={api_token}
```
**Description**: This API lists all the groups in a team
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_id` | string | Yes | The unique ID of the team |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`filter[type]` | string | No | To filter Groups by type |
|`page[limit]` | string | No | Limit indicates the number of items to be listed |
|`page[offset]` | string | No | Offset indicates from where the listing should start |
---
#### Get Team Info
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/teams/team_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/teams/team_id?api_token={api_token}
```
**Description**: This API fetches all details about a WorkDrive team
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_id` | string | Yes | The unique ID that represents a team |
---
#### Get Team Members
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/teams/team_id/users`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/teams/team_id/users?filter[user]={filter[user]}&search[all]={search[all]}&api_token={api_token}
```
**Description**: This API fetches all members of a WorkDrive team
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_id` | string | Yes | The unique ID that represents a team |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`filter[user]` | string | No | To get specific member's details, enter their ZUID |
|`search[all]` | string | No | To search team members by custom search query |
---
#### Get Current Team Member
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/teams/team_id/currentuser`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/teams/team_id/currentuser?api_token={api_token}
```
**Description**: This API fetches team member information about the user with respect to the team
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_id` | string | Yes | The unique ID that represents a team |
---
#### Change Team Description
**Method**: `PATCH` | **LowCodeAPI Path**: `/workdrive/api/v1/teams/team_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/teams/team_id?api_token={api_token}
```
**Description**: This API changes your team description in WorkDrive
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_id` | string | Yes | The unique ID that represents a team |
**Request Body**:
```json
{
"description": "<string>"
}
```
---
#### Get Team Folders in a Team
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/teams/team_id/teamfolders`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/teams/team_id/teamfolders?filter[type]={filter[type]}&page[limit]={page[limit]}&page[offset]={page[offset]}&api_token={api_token}
```
**Description**: This API fetches the list of all team folders in a team
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_id` | string | Yes | The unique ID that represents a team |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`filter[type]` | string | No | To filter by team folder type |
|`page[limit]` | string | No | Limit indicates the number of items to be listed |
|`page[offset]` | string | No | Offset indicates from where the listing should start |
---
#### Get List of Data Templates in a Team
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/teams/team_id/datatemplates`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/teams/team_id/datatemplates?api_token={api_token}
```
**Description**: This API fetches a list of all the data templates associated with a WorkDrive team
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_id` | string | Yes | The unique ID that represents a team |
---
### Category: Templates
#### Assign/Remove Template Admin role
**Method**: `PATCH` | **LowCodeAPI Path**: `/workdrive/api/v1/users/team_member_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/users/team_member_id?api_token={api_token}
```
**Description**: Only template admins can create, edit, delete, and manage Org Templates
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_member_id` | string | Yes | The team-member-id of the user |
**Request Body**:
```json
{
"is_org_template_admin": "<boolean>"
}
```
---
#### Get My Templates Library ID
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/users/team_member_id/libraries`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/users/team_member_id/libraries?filter[type]={filter[type]}&api_token={api_token}
```
**Description**: This API fetches the My Templates Library ID of the user
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_member_id` | string | Yes | The team-member-id of the user |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`filter[type]` | string | No | The value must be the integer '2' for the Template Library |
---
#### Get Org Templates Library ID
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/teams/team_id/libraries`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/teams/team_id/libraries?filter[type]={filter[type]}&api_token={api_token}
```
**Description**: This API fetches the Org Templates Library ID of the team
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_id` | string | Yes | The unique ID that represents a team |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`filter[type]` | string | No | The value must be the integer '2' for the template library |
---
#### Get Public Templates Library ID
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/libraries`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/libraries?filter[type]={filter[type]}&filter[space]={filter[space]}&api_token={api_token}
```
**Description**: This API fetches the Public Templates Library ID
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`filter[type]` | string | Yes | The value should be the integer '2' for the template library |
|`filter[space]` | string | Yes | The value should be the string 'template' denoting template library |
---
#### Get Template Library Info
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/libraries/library_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/libraries/library_id?api_token={api_token}
```
**Description**: This API fetches the resource information of the template library, such as capabilities and view preferences
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`library_id` | string | Yes | The template library ID of My Templates/Org Templates/Public Templates |
---
#### Get Template Library Permissions
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/libraries/library_id/permissions`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/libraries/library_id/permissions?api_token={api_token}
```
**Description**: This API fetches the permission details of a Template Library
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`library_id` | string | Yes | The template library ID of My Templates/Org Templates/Public Templates |
---
#### Get all Templates from a Template Library
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/libraries/library_id/files`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/libraries/library_id/files?filter[type]={filter[type]}&filter[category_id]={filter[category_id]}&sort={sort}&api_token={api_token}
```
**Description**: This API fetches all the "active" templates within a template library
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`library_id` | string | Yes | The template library ID of My Templates/Org Templates/Public Templates |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`filter[type]` | string | No | Documents (Writer) or spreadsheets (Sheet) |
|`filter[category_id]` | string | No | Filters templates by category |
|`sort` | string | No | Sorts templates in ascending or descending order |
---
#### Get all Templates in a Template Category
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/category/category_id/files`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/category/category_id/files?filter[type]={filter[type]}&sort={sort}&api_token={api_token}
```
**Description**: This API fetches all the "active" templates within a template category
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`category_id` | string | Yes | The template category ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`filter[type]` | string | No | Documents (Writer) or spreadsheets (Sheet) |
|`sort` | string | No | Sorts templates in ascending or descending order |
---
#### Get Category Info
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/category/category_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/category/category_id?api_token={api_token}
```
**Description**: This API fetches the resource information of a template category, such as name, and library ID
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`category_id` | string | Yes | The template category ID |
---
#### Get list of Categories
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/libraries/library_id/categories`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/libraries/library_id/categories?api_token={api_token}
```
**Description**: This API fetches all the active template categories within a template library (My Templates or Org Templates)
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`library_id` | string | Yes | The template library ID of My Templates/Org Templates/Public Templates |
---
#### Create Category
**Method**: `POST` | **LowCodeAPI Path**: `/workdrive/api/v1/category`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/category?api_token={api_token}
```
**Description**: This API creates a new template category within a template library (My Templates or Org Templates)
**Request Body**:
```json
{
"category_name": "<string>",
"library_id": "<string>"
}
```
---
#### Save File as Template
**Method**: `POST` | **LowCodeAPI Path**: `/workdrive/api/v1/files/library_id/saveastemplate`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/files/library_id/saveastemplate?api_token={api_token}
```
**Description**: 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**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`library_id` | string | Yes | The template library ID of My Templates/Org Templates/Public Templates where the template is to be saved |
**Request Body**:
```json
{
"resource_id": "<string>",
"name": "<string>"
}
```
---
#### Change Sort Type and Order
**Method**: `PATCH` | **LowCodeAPI Path**: `/workdrive/api/v1/libraries/library_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/libraries/library_id?api_token={api_token}
```
**Description**: This API changes the sort type (Name/Last Modified/Time Created) and sort order (ascending/descending) of templates within a Template Library
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`library_id` | string | Yes | The template library ID of My Templates/Org Templates/Public Templates |
**Request Body**:
```json
{
"view_pref": "<string>"
}
```
---
#### Delete Category
**Method**: `PATCH` | **LowCodeAPI Path**: `/workdrive/api/v1/category/category_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/category/category_id?api_token={api_token}
```
**Description**: This API deletes a template category permanently
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`category_id` | string | Yes | The template category ID |
**Request Body**:
```json
{
"status": "<number>"
}
```
---
#### Update Template Category
**Method**: `POST` | **LowCodeAPI Path**: `/workdrive/api/v1/category/category_id/relationships/files`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/category/category_id/relationships/files?api_token={api_token}
```
**Description**: This API associates a template to a different template category
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`category_id` | string | Yes | The category_id into which the template needs to be put |
**Request Body**:
```json
{
"id": "<string>",
"resource_id": "<string>"
}
```
---
*Note: Showing 15 of 16 endpoints in this category.*
---
### Category: Users
#### Get User Info
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/users/me`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/users/me?api_token={api_token}
```
**Description**: This API fetches information about the user.
---
#### Get All Teams of User
**Method**: `GET` | **LowCodeAPI Path**: `/workdrive/api/v1/users/zuid`
**Full URL**:
```
https://api.lowcodeapi.com/zohoworkdrive/workdrive/api/v1/users/zuid?api_token={api_token}
```
**Description**: This API returns a list of teams of the user.
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`zuid` | string | Yes | The unique ID that represents the current user |
---
## Complete Endpoint Reference
For a complete list of all 138 endpoints, refer to:
- **OpenAPI Definition**: `https://backend.lowcodeapi.com/zohoworkdrive/definition`
- **Official Provider Documentation**: https://workdrive.zoho.com/apidocs/v1/overview