Get Trashed List
Purpose
To retrieve the list of documents which are moved to trash with specified parameters.
HTTP Request URL
https://{zohoapis_domain}/writer/api/v1/documents
Query Parameters
| Parameter | Data Type | Description |
| Mandatory Parameters | ||
| category | String | trashed - Get only the list of documents moved to trash. |
| Optional Parameters | ||
| offset | Integer | Set offset parameter to get the list of trashed documents from the respective page. By default, offset value will be 0. |
| limit | Integer | Set document limit and retrieve the list of trashed documents within the specified limit. By default, limit value will be taken as 10. |
| sortby | String | created_time By default, the documents will be sorted and listed based on the modified_time. |
| sort_order_by | String | ascending By default, the documents will be sorted and listed in the descending order. |
| resource_type | String | Enter the document type from which the specified list needs to be retrieved. Possible values: fillable/merge/sign |
Sample Request
Copiedcurl --location --request GET "https://www.zohoapis.com/writer/api/v1/documents?limit=5&sortby=modified_time&sort_order_by=descending&category=trashed&offset=2" \
--header "Authorization: Zoho-oauthtoken xxx.yyy.zzz” \
--data ""
Sample Response
Copied{
"offset": 2,
"documents": [
{
"created_time": "2019-02-11T06:25:22Z",
"role": "OWNER",
"modified_time_ms": 1550832664805,
"parent_folder_id": "folder",
"collaboration_id": "1203298639215247842",
"last_opened_time": "2019-02-22T10:50:24Z",
"open_url": "https://writer.zoho.com/writer/open/4gfw6e64d92cba1224a7c98ddc17716bf7c90",
"is_favourite": false,
"type": "document",
"document_id": "4gfw6e64d92cba1224a7c98ddc17716bf7c90",
"last_opened_time_ms": 1550832624103,
"thumbnail_url": "https://writer.zoho.com/writer/thumbnail/4gfw6e64d92cba1224a7c98ddc17716bf7c90",
"created_by": "Amelia",
"document_name": "Cover Letter",
"created_time_ms": 1549866322416,
"modified_time": "2019-02-22T10:51:04Z",
"preview_url": "https://writer.zoho.com/writer/preview/4gfw6e64d92cba1224a7c98ddc17716bf7c90",
"creator_id": "1308724",
"download_url": "https://writer.zoho.com/api/v1/download/4gfw6e64d92cba1224a7c98ddc17716bf7c90",
"permalink": "https://docsdev.zoho.com/file/4gfw6e64d92cba1224a7c98ddc17716bf7c90",
"lastmodified_by": [
{
"email_id": "amelia@zylker.com",
"profile_photo": "https://contacts.zoho.com/file?t=user&ID=1308724&fs=thumb",
"user_id": "1308724",
"display_name": "Amelia"
}
],
"status": "trashed"
},
{
"created_time": "2019-02-19T08:25:18Z",
"role": "OWNER",
"modified_time_ms": 1550564719737,
"parent_folder_id": "folder",
"collaboration_id": "1203298667820570550",
"last_opened_time": "2019-02-19T08:25:18Z",
"open_url": "https://writer.zoho.com/writer/open/h36bccb801b02c0a3475f9f99b3fa9adb6cb4",
"is_favourite": false,
"type": "document",
"document_id": "h36bccb801b02c0a3475f9f99b3fa9adb6cb4",
"last_opened_time_ms": 1550564718624,
"thumbnail_url": "https://writer.zoho.com/writer/thumbnail/h36bccb801b02c0a3475f9f99b3fa9adb6cb4",
"created_by": "Amelia",
"document_name": "19Feb2019",
"created_time_ms": 1550564718624,
"modified_time": "2019-02-19T08:25:19Z",
"preview_url": "https://writer.zoho.com/writer/preview/h36bccb801b02c0a3475f9f99b3fa9adb6cb4",
"creator_id": "1308724",
"download_url": "https://writer.zoho.com/api/v1/download/h36bccb801b02c0a3475f9f99b3fa9adb6cb4",
"permalink": "https://docsdev.zoho.com/file/h36bccb801b02c0a3475f9f99b3fa9adb6cb4",
"lastmodified_by": [
{
"email_id": "amelia@zylker.com",
"profile_photo": "https://contacts.zoho.com/file?t=user&ID=1308724&fs=thumb",
"user_id": "1308724",
"display_name": "Amelia"
}
],
"status": "trashed"
},
{
"created_time": "2019-02-01T08:21:23Z",
"role": "OWNER",
"modified_time_ms": 1549436047554,
"parent_folder_id": "folder",
"collaboration_id": "1203298604109363363",
"last_opened_time": "2019-02-01T08:22:45Z",
"open_url": "https://writer.zoho.com/writer/open/4gfw6ff7211bf001441b899ae27e4213a4d0f",
"is_favourite": false,
"type": "document",
"document_id": "4gfw6ff7211bf001441b899ae27e4213a4d0f",
"last_opened_time_ms": 1549009365724,
"thumbnail_url": "https://writer.zoho.com/writer/thumbnail/4gfw6ff7211bf001441b899ae27e4213a4d0f",
"created_by": "Amelia",
"document_name": "Docs Vs TD Impacts",
"created_time_ms": 1549009283177,
"modified_time": "2019-02-06T06:54:07Z",
"preview_url": "https://writer.zoho.com/writer/preview/4gfw6ff7211bf001441b899ae27e4213a4d0f",
"creator_id": "1308724",
"download_url": "https://writer.zoho.com/api/v1/download/4gfw6ff7211bf001441b899ae27e4213a4d0f",
"permalink": "https://docsdev.zoho.com/file/4gfw6ff7211bf001441b899ae27e4213a4d0f",
"lastmodified_by": [
{
"email_id": "amelia@zylker.com",
"profile_photo": "https://contacts.zoho.com/file?t=user&ID=1308724&fs=thumb",
"user_id": "1308724",
"display_name": "Amelia"
}
],
"status": "trashed"
},
{
"created_time": "2019-02-06T02:26:37Z",
"role": "OWNER",
"modified_time_ms": 1549420317623,
"parent_folder_id": "folder",
"collaboration_id": "1203298620925806607",
"last_opened_time": "2019-02-06T02:31:46Z",
"open_url": "https://writer.zoho.com/writer/open/4gfw61fdb6002c4cc4f38b2b2c4f15363cbb1",
"is_favourite": false,
"type": "document",
"document_id": "4gfw61fdb6002c4cc4f38b2b2c4f15363cbb1",
"last_opened_time_ms": 1549420306482,
"thumbnail_url": "https://writer.zoho.com/writer/thumbnail/4gfw61fdb6002c4cc4f38b2b2c4f15363cbb1",
"created_by": "Amelia",
"document_name": "text_import",
"created_time_ms": 1549419997606,
"modified_time": "2019-02-06T02:31:57Z",
"preview_url": "https://writer.zoho.com/writer/preview/4gfw61fdb6002c4cc4f38b2b2c4f15363cbb1",
"creator_id": "1308724",
"download_url": "https://writer.zoho.com/api/v1/download/4gfw61fdb6002c4cc4f38b2b2c4f15363cbb1",
"permalink": "https://docsdev.zoho.com/file/4gfw61fdb6002c4cc4f38b2b2c4f15363cbb1",
"lastmodified_by": [
{
"email_id": "amelia@zylker.com",
"profile_photo": "https://contacts.zoho.com/file?t=user&ID=1308724&fs=thumb",
"user_id": "1308724",
"display_name": "Amelia"
}
],
"status": "trashed"
},
{
"created_time": "2019-02-06T02:21:41Z",
"role": "OWNER",
"modified_time_ms": 1549419702883,
"parent_folder_id": "folder",
"collaboration_id": "1203298620918741706",
"last_opened_time": "2019-02-06T02:21:41Z",
"open_url": "https://writer.zoho.com/writer/open/4gfw6a4051dd626304c809880cf3ebf0cf244",
"is_favourite": false,
"type": "document",
"document_id": "4gfw6a4051dd626304c809880cf3ebf0cf244",
"last_opened_time_ms": 1549419701164,
"thumbnail_url": "https://writer.zoho.com/writer/thumbnail/4gfw6a4051dd626304c809880cf3ebf0cf244",
"created_by": "Amelia",
"document_name": "29 Jan",
"created_time_ms": 1549419701164,
"modified_time": "2019-02-06T02:21:42Z",
"preview_url": "https://writer.zoho.com/writer/preview/4gfw6a4051dd626304c809880cf3ebf0cf244",
"creator_id": "1308724",
"download_url": "https://writer.zoho.com/api/v1/download/4gfw6a4051dd626304c809880cf3ebf0cf244",
"permalink": "https://docsdev.zoho.com/file/4gfw6a4051dd626304c809880cf3ebf0cf244",
"lastmodified_by": [
{
"email_id": "amelia@zylker.com",
"profile_photo": "https://contacts.zoho.com/file?t=user&ID=1308724&fs=thumb",
"user_id": "1308724",
"display_name": "Amelia"
}
],
"status": "trashed"
}
],
"total_count": 17,
"limit": 5
}Show full
Show less