Get Sign Templates
Purpose
To get the list of available sign templates.
HTTP Request URL
https://{zohoapis_domain}/writer/api/v1/documents
Query Parameters
Parameter | Data Type | Description |
Mandatory Parameters | ||
resource_type | String | Pass the string value as "sign" as you wanted the list of sign templates. |
Optional Parameters | ||
offset | Integer | Set offset parameter to get the list of sign templates from the respective page. By default, offset value will be 0. |
limit | Integer | Set document limit and retrieve the list of sign templates within the specified limit. By default, limit value will be taken as 10. |
sortby | String | created_time By default, the templates will be sorted and listed based on the modified_time. |
sort_order_by | String | ascending By default, the templates will be sorted and listed in the descending order. |
category | String | all By default, the category value will be all. Here, all the sign templates will be listed. |
Sample Request
Copiedcurl "https://www.zohoapis.com/writer/api/v1/documents?resource_type=sign&limit=5&offset=2
&sortby=modified_time&sort_order_by=descending"
-X GET
-H "Authorization: Zoho-oauthtoken xyz"
Sample Response
Copied{
"documents": [
{
"document_name": "Presales tips",
"open_url": "https://writer.zoho.com/writer/open/1x3q99f2155c6737241ea929eb72ad141da7c",
"is_favourite": false,
"thumbnail_url": "https://writer.zoho.com/writer/thumbnail/1x3q99f2155c6737241ea929eb72ad141da7c",
"document_id": "1x3q99f2155c6737241ea929eb72ad141da7d",
"type": "document",
"modified_time": "2020-06-23T10:13:11Z",
"download_url": "https://writer.zoho.com/writer/api/v1/download/1x3q99f2155c6737241ea929eb72ad141da7c",
"lastmodified_by": [
{
"email_id": "amelia@zylker.com",
"profile_photo": "https://contacts.zoho.com/file?t=user&ID=1234&fs=thumb",
"user_id": "456215787",
"timezone": "Asia/Kolkata",
"language": "en",
"display_name": "Amelia"
}
],
"created_time": "2020-06-16T08:46:40Z",
"last_opened_time": "2020-06-16T08:46:40Z",
"created_by": "Amelia",
"created_time_ms": 1592297200540,
"preview_url": "https://writer.zoho.com/writer/zwpreview/1x3q99f2155c6737241ea929eb72ad141da7c",
"creator_id": "53884257",
},
{
"open_url": "https://writer.zoho.com/writer/open/1slbxa0f3e1ecc88b4403b5f1b66617f0e92c",
"is_favourite": false,
"thumbnail_url": "https://writer.zoho.com/writer/thumbnail/1slbxa0f3e1ecc88b4403b5f1b66617f0e92c",
"document_id": "1slbxa0f3e1ecc88b4403b5f1b66617f0e92c",
"type": "document",
"document_name": "Investment details",
"modified_time": "2020-12-01T12:56:50Z",
"download_url": "https://writer.zoho.com/writer/api/v1/download/1slbxa0f3e1ecc88b4403b5f1b66617f0e92c",
"lastmodified_by": [
{
"email_id": "John@zylker.com",
"profile_photo": "https://contacts.zoho.com/file?t=user&ID=53884257&fs=thumb",
"user_id": "53884257",
"timezone": "Asia/Kolkata",
"language": "en",
"display_name": "John"
}
],
"created_time": "2020-12-01T09:01:43Z",
"last_opened_time": "2020-12-01T09:01:43Z",
"created_by": "John",
"created_time_ms": 1606813303541,
"preview_url": "https://writer.zoho.com/writer/zwpreview/1slbxa0f3e1ecc88b4403b5f1b66617f0e92c",
"creator_id": "53884257",
},
{
"open_url": "https://writer.zoho.com/writer/open/ll60fcb6bfab23ffd4821804dc629bbd16656",
"is_favourite": false,
"thumbnail_url": "https://writer.zoho.com/writer/thumbnail/ll60fcb6bfab23ffd4821804dc629bbd16656",
"document_id": "ll60fcb6bfab23ffd4821804dc629bbd16656",
"type": "document",
"document_name": "Finalised Document",
"modified_time": "2020-09-15T03:57:36Z",
"download_url": "https://writer.zoho.com/writer/api/v1/download/ll60fcb6bfab23ffd4821804dc629bbd16656",
"lastmodified_by": [
{
"email_id": "mike@zylker.com",
"profile_photo": "https://contacts.zoho.com/file?t=user&ID=648787570&fs=thumb",
"user_id": "648787570",
"timezone": "Asia/Kolkata",
"language": "en",
"display_name": "Mike"
}
],
"created_time": "2020-09-03T07:18:03Z",
"last_opened_time": "2020-09-03T07:18:03Z",
"created_by": "Mike",
"created_time_ms": 1599117483853,
"preview_url": "https://writer.zoho.com/writer/zwpreview/ll60fcb6bfab23ffd4821804dc629bbd16656",
"creator_id": "53884257",
"name": "New Document",
},
{
"open_url": "https://writer.zoho.com/writer/open/6zqn0d6f9ca0d3ba140f892b0603baae3e8d3",
"is_favourite": false,
"thumbnail_url": "https://writer.zoho.com/writer/thumbnail/6zqn0d6f9ca0d3ba140f892b0603baae3e8d3",
"document_id": "6zqn0d6f9ca0d3ba140f892b0603baae3e8d3",
"type": "document",
"document_name": "Invoices",
"modified_time": "2020-09-25T03:54:17Z",
"download_url": "https://writer.zoho.com/writer/api/v1/download/6zqn0d6f9ca0d3ba140f892b0603baae3e8d3",
"lastmodified_by": [
{
"email_id": "jack@zylker.com",
"profile_photo": "https://contacts.zoho.com/file?t=user&ID=53884257&fs=thumb",
"user_id": "53884257",
"timezone": "Asia/Kolkata",
"language": "en",
"display_name": "Jack"
}
],
"created_time": "2020-09-21T08:48:32Z",
"last_opened_time": "2020-09-21T08:48:32Z",
"created_by": "Jack",
"created_time_ms": 1600678112999,
"preview_url": "https://writer.zoho.com/writer/zwpreview/6zqn0d6f9ca0d3ba140f892b0603baae3e8d3",
"creator_id": "53884257",
"name": "Product Details",
},
{
"open_url": "https://writer.zoho.com/writer/open/lvm1t3b4d9576b7b4415d958405b161ee0b67",
"is_favourite": false,
"thumbnail_url": "https://writer.zoho.com/writer/thumbnail/lvm1t3b4d9576b7b4415d958405b161ee0b67",
"document_id": "lvm1t3b4d9576b7b4415d958405b161ee0b67",
"type": "document",
"document_name": "Product prices",
"modified_time": "2020-12-10T11:19:35Z",
"download_url": "https://writer.zoho.com/writer/api/v1/download/lvm1t3b4d9576b7b4415d958405b161ee0b67",
"lastmodified_by": [
{
"email_id": "amelia@zylker.com",
"profile_photo": "https://contacts.zoho.com/file?t=user&ID=53884257&fs=thumb",
"user_id": "53884257",
"timezone": "Asia/Kolkata",
"language": "en",
"display_name": "Amelia"
}
],
"created_time": "2020-09-22T12:15:28Z",
"last_opened_time": "2020-09-22T12:15:28Z",
"created_by": "Amelia",
"created_time_ms": 1600776928655,
"preview_url": "https://writer.zoho.com/writer/zwpreview/lvm1t3b4d9576b7b4415d958405b161ee0b67",
"creator_id": "53884257",
"name": "Sample file",
}
],
"total_count": 33,
"limit": 5"
}