Get all Templates in a Template Category

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

This API fetches all the "active" templates within a template category.

Endpoints

OAuth Scope

WorkDrive.libraries.categories.READCopied!

Request Example

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

Path Parameters

category_idstring(Required)

The template category ID

Query Parameters

Note:

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

filter[type]string(Optional)

value could be:

documents - for document templates (Writer)
spreadsheets - for spreadsheet templates (Sheet)

sortstring(Optional)

The value to the param "sort" should follow the pattern:
sort=<sortType> OR sort=-<sortType>

The minus sign (-) before the sortType indicates the descending order

Response Example

R004

R004

F001

200
200
400
Copied!
  {
    "data": [
      {
        "id": "mvfyde371e9a5562241d89372f876919d3788",
        "type": "files",
        "attributes": {
          "modified_by_zuid": "56865813",
          "is_locked": false,
          "conv_engine_type": 0,
          "is_fillable_resource": false,
          "is_published": false,
          "destination_id": "t4y5t30481213b4ee415d85a111634df62b63",
          "storage_info": {
            "files_count": 0,
            "folders_count": 0,
            "size_in_bytes": 0,
            "storage_used_in_bytes": 0,
            "storage_used_by_app_in_bytes": 0,
            "storage_used_by_workdrive_in_bytes": 0
          },
          "type": "writer",
          "created_time_i18": "Nov 8, 2:57 PM",
          "associated_data_templates": [],
          "modified_time_in_millisecond": 1636363627555,
          "status_change_time": "Nov 8, 2:57 PM",
          "download_url": "https://downloadserver.zoho.com/v1/workdrive/download/mvfyde371e9a5562241d89372f876919d3788",
          "comment_badge_count": 0,
          "is_app_associated": false,
          "created_time": "Nov 8, 2:57 PM",
          "lock_status": 2,
          "is_folder": false,
          "resource_type": 2001,
          "is_email_in_upload": false,
          "display_attr_name": "qrq3fqfqr",
          "created_by": "Zylker Creation",
          "display_html_name": "qrq3fqfqr",
          "labels": [],
          "parent_id": "t4y5t30481213b4ee415d85a111634df62b63",
          "name": "qrq3fqfqr",
          "status_change_time_in_millisecond": 1636363627555,
          "permalink": "https://writer.zoho.com/writer/open/mvfyde371e9a5562241d89372f876919d3788",
          "favorite": false,
          "new_badge_count": 0,
          "status": 1,
          "modified_time_i18": "Nov 8, 2:57 PM",
          "extn": "zwriter",
          "shortcut_link": "",
          "status_change_time_i18": "Nov 8, 2:57 PM",
          "description": "",
          "uploaded_time_in_millisecond": 1636363627245,
          "thumbnail_url": "https://previewengine.zoho.com/thumbnail/WD/mvfyde371e9a5562241d89372f876919d3788",
          "title": "",
          "modified_time": "Nov 8, 2:57 PM",
          "library_id": "t4y5t30481213b4ee415d85a111634df62b63",
          "icon_class": "writer",
          "created_time_in_millisecond": 1636363627245,
          "owner": "57056915",
          "creator": "56865813",
          "capabilities": {
            "can_read": true,
            "can_share": false,
            "can_remove_share": false,
            "can_delete": true,
            "can_edit": true,
            "can_upload_files": true,
            "can_trash": true,
            "can_rename": true,
            "can_restore": false,
            "can_copy": true,
            "can_move": false,
            "can_zip": true,
            "can_download": true,
            "can_emailattach": true,
            "can_publish": false,
            "can_create_task": true,
            "can_share_support": false,
            "can_label": true,
            "can_delist_file": false,
            "can_associate_data_template": true,
            "can_favorite": true,
            "can_checkout": true,
            "can_cancel_checkout": false,
            "can_discard_checkout": false,
            "can_checkin": false,
            "can_read_comment": true,
            "can_create_comment": true,
            "can_trash_files": true
          },
          "uploaded_time_i18": "Nov 8, 2:57 PM",
          "is_external_upload": false,
          "watch_preference": {
            "watch": false,
            "notifyemail": false,
            "notifybell": false
          },
          "opened_time_in_millisecond": 0,
          "edit_badge_count": 0,
          "share_data": [],
          "uploaded_time": "Nov 8, 2:57 PM",
          "has_folders": false,
          "service_type": "zw",
          "display_url_name": "qrq3fqfqr",
          "is_unread": false,
          "modified_by": "Zylker Creation",
          "embed_props": {}
        },
        "relationships": {
          "folders": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/folders",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/folders"
            }
          },
          "unzip": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/unzip",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/unzip"
            }
          },
          "accesschartdata": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/accesschartdata",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/accesschartdata"
            }
          },
          "resourceproperty": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/resourceproperty",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/resourceproperty"
            }
          },
          "shortcut": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/shortcut",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/shortcut"
            }
          },
          "importfile": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/importfile",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/importfile"
            }
          },
          "permissions": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/permissions",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/permissions"
            }
          },
          "saveastemplate": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/saveastemplate",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/saveastemplate"
            }
          },
          "links": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/links",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/links"
            }
          },
          "copy": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/copy",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/copy"
            }
          },
          "previewzip": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/previewzip",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/previewzip"
            }
          },
          "tasks": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/tasks",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/tasks"
            }
          },
          "custommetadata": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/custommetadata",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/custommetadata"
            }
          },
          "comments": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/comments",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/comments"
            }
          },
          "previewinfo": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/previewinfo",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/previewinfo"
            }
          },
          "publiclink": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/publiclink",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/publiclink"
            }
          },
          "parentfolders": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/parentfolders",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/parentfolders"
            }
          },
          "versions": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/versions",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/versions"
            }
          },
          "supportshare": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/supportshare",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/supportshare"
            }
          },
          "timeline": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/timeline",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/timeline"
            }
          },
          "files": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/files",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/files"
            }
          },
          "accessdata": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/accessdata",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/accessdata"
            }
          },
          "breadcrumbs": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/breadcrumbs",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/breadcrumbs"
            }
          },
          "entity": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/entity",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/entity"
            }
          },
          "statistics": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/statistics",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/statistics"
            }
          },
          "appdata": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/relationships/appdata",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788/appdata"
            }
          }
        },
        "links": {
          "self": "https://www.zohoapis.com/workdrive/api/v1/files/mvfyde371e9a5562241d89372f876919d3788"
        }
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "R004",
        "title": "Invalid resourceId passed. Please use a valid resourceId"
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "F001",
        "title": "Invalid filter type passed. Please pass a valid filter."
      }
    ]
  }
                
Show full