Get List of Templates
Purpose
To get the list of templates based on the specified parameter.
HTTP Request URL
https://{zohoapis_domain}/writer/api/v1/templates
Query Parameters
Parameter | Data Type | Description |
Optional Parameters | ||
type | String | Specify the type (either personal or organization) of templates that needs to be listed. For example: type = personal / organization By default, the type value will be 'personal'. Hence, personal templates will be listed. |
offset | Integer | Set offset parameter to get the list of templates from the respective page. By default, offset value will be 0. |
limit | Integer | Set document limit and retrieve the list of templates within the specified limit. By default, limit value will be taken as 50. |
sortby | String | name Get the list of templates in the alphabetical order. created_time Get the list of templates with respect to the template created time. modified_time Get the list of templates with respect to the last modified time of the template. |
Sample Request
Copiedcurl "https://www.zohoapis.com/writer/api/v1/templates?type=personal"
-X GET
-H "Authorization: Zoho-oauthtoken xyz"
Sample Response
Copied{
"total_count": 5,
"templates": [
{
{
"created_time": "2019-08-28T16:30:33Z",
"modified_time_ms": 1567009834477,
"owner_id": "14335411",
"last_opened_time": "2019-08-28T16:30:33Z",
"open_url": "https://writer.zoho.com/writer/template/a7iyybadb",
"last_opened_time_ms": 1567009833936,
"type": "template",
"thumbnail_url":"https://writer.zoho.com/writer/thumbnail/a7iyybadb",
"created_by": "amelia",
"created_time_ms": 1567009833936,
"modified_time": "2019-08-28T16:30:34Z",
"preview_url": "https://writer.zoho.com/writer/zwpreview/a7iyybadbb8",
"creator_id": "11122329",
"name": " New Template",
"id": "a7iyybadbb8b74e1147638bad04abc161e79e",
"permalink": "https://docs.zoho.com/file/a7iyybadb",
"status": "active"
}
},
{
"created_time": "2019-08-28T16:30:33Z",
"modified_time_ms": 1567009834477,
....
}
]
}