Get Favourite List
Purpose
To retrieve the list of documents which are favourite to the user with specified parameters.
HTTP Request URL
https://{zohoapis_domain}/writer/api/v1/documents
Query Parameters
| Parameter | Data Type | Description |
| Mandatory Parameters | ||
| category | String | favourite - Get only the list of favourite documents. |
| Optional Parameters | ||
| offset | Integer | Set offset parameter to get the list of favourite documents from the respective page. By default, offset value will be 0. |
| limit | Integer | Set document limit and retrieve the list of favourite 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=favourite&offset=2" \
--header "Authorization: Zoho-oauthtoken xxx.yyy.zzz” \
--data ""
Sample Response
Copied{
"offset": 2,
"documents": [
{
"created_time": "2017-09-15T12:00:49Z",
"role": "SHAREDREAD",
"modified_time_ms": 1546433856984,
"parent_folder_id": "folder",
"collaboration_id": "1205440119446774215",
"last_opened_time": "2018-02-22T15:01:44Z",
"open_url": "https://writer.zoho.com/writer/open/xrbzp79730c6cdef14c0e867d2c3d28848b9a",
"is_favourite": true,
"type": "document",
"document_id": "xrbzp79730c6cdef14c0e867d2c3d28848b9a",
"last_opened_time_ms": 1519311704593,
"thumbnail_url": "https://writer.zoho.com/writer/thumbnail/xrbzp79730c6cdef14c0e867d2c3d28848b9a",
"created_by": "Amelia",
"document_name": "Favourite documents",
"created_time_ms": 1505476849885,
"modified_time": "2019-01-02T12:57:36Z",
"preview_url": "https://writer.zoho.com/writer/preview/xrbzp79730c6cdef14c0e867d2c3d28848b9a",
"creator_id": "1306446",
"download_url": "https://writer.zoho.com/api/v1/download/xrbzp79730c6cdef14c0e867d2c3d28848b9a",
"permalink": "https://docs.zoho.com/file/xrbzp79730c6cdef14c0e867d2c3d28848b9a",
"lastmodified_by": [
{
"email_id": "amelia@zylker.com",
"profile_photo": "https://contacts.zoho.com/file?t=user&ID=1306446&fs=thumb",
"user_id": "1306446",
"display_name": "Amelia"
}
],
"status": "active"
},
{
"created_time": "2019-01-02T12:56:54Z",
"role": "SHAREDREADCOMMENT",
"modified_time_ms": 1546433814022,
"parent_folder_id": "folder",
"collaboration_id": "1205440119446774108",
"last_opened_time": "2019-01-02T12:56:54Z",
"open_url": "https://writer.zoho.com/writer/open/xrbzpd312f23e2c324733a7493c2249fb479d",
"is_favourite": true,
"type": "document",
"document_id": "xrbzpd312f23e2c324733a7493c2249fb479d",
"last_opened_time_ms": 1546433814022,
"thumbnail_url": "https://writer.zoho.com/writer/thumbnail/xrbzpd312f23e2c324733a7493c2249fb479d",
"created_by": "Amelia",
"document_name": "Public documents",
"created_time_ms": 1546433814022,
"modified_time": "2019-01-02T12:56:54Z",
"preview_url": "https://writer.zoho.com/writer/preview/xrbzpd312f23e2c324733a7493c2249fb479d",
"creator_id": "1306446",
"download_url": "https://writer.zoho.com/api/v1/download/xrbzpd312f23e2c324733a7493c2249fb479d",
"permalink": "https://docs.zoho.com/file/xrbzpd312f23e2c324733a7493c2249fb479d",
"lastmodified_by": [
{
"email_id": "amelia@zylker.com",
"profile_photo": "https://contacts.zoho.com/file?t=user&ID=1306446&fs=thumb",
"user_id": "1306446",
"display_name": "Amelia"
}
],
"status": "active"
},
{
"created_time": "2019-01-02T12:54:04Z",
"role": "SHAREDREADWRITE",
"modified_time_ms": 1546433644022,
"parent_folder_id": "folder",
"collaboration_id": "1205440119625339725",
"last_opened_time": "2019-01-02T12:54:04Z",
"open_url": "https://writer.zoho.com/writer/open/xrbzp62ccd54007ba46a4bc0f26161615c7ba",
"is_favourite": true,
"type": "document",
"document_id": "xrbzp62ccd54007ba46a4bc0f26161615c7ba",
"last_opened_time_ms": 1546433644022,
"thumbnail_url": "https://writer.zoho.com/writer/thumbnail/xrbzp62ccd54007ba46a4bc0f26161615c7ba",
"created_by": "Amelia",
"document_name": "Password",
"created_time_ms": 1546433644022,
"modified_time": "2019-01-02T12:54:04Z",
"preview_url": "https://writer.zoho.com/writer/preview/xrbzp62ccd54007ba46a4bc0f26161615c7ba",
"creator_id": "1306446",
"download_url": "https://writer.zoho.com/api/v1/download/xrbzp62ccd54007ba46a4bc0f26161615c7ba",
"permalink": "https://docs.zoho.com/file/xrbzp62ccd54007ba46a4bc0f26161615c7ba",
"lastmodified_by": [
{
"email_id": "amelia@zylker.com",
"profile_photo": "https://contacts.zoho.com/file?t=user&ID=1306446&fs=thumb",
"user_id": "1306446",
"display_name": "Amelia"
}
],
"status": "active"
},
{
"created_time": "2019-01-02T12:52:24Z",
"role": "COOWNER",
"modified_time_ms": 1546433575567,
"parent_folder_id": "folder",
"collaboration_id": "1205440119625340239",
"last_opened_time": "2019-01-02T12:52:24Z",
"open_url": "https://writer.zoho.com/writer/open/xrbzp97eddb1780bb46ff8e9b735da3ccf4b0",
"is_favourite": true,
"type": "document",
"document_id": "xrbzp97eddb1780bb46ff8e9b735da3ccf4b0",
"last_opened_time_ms": 1546433544726,
"thumbnail_url": "https://writer.zoho.com/writer/thumbnail/xrbzp97eddb1780bb46ff8e9b735da3ccf4b0",
"created_by": "Amelia",
"document_name": "Organised documents",
"created_time_ms": 1546433544726,
"modified_time": "2019-01-02T12:52:55Z",
"preview_url": "https://writer.zoho.com/writer/preview/xrbzp97eddb1780bb46ff8e9b735da3ccf4b0",
"creator_id": "1306446",
"download_url": "https://writer.zoho.com/api/v1/download/xrbzp97eddb1780bb46ff8e9b735da3ccf4b0",
"permalink": "https://docs.zoho.com/file/xrbzp97eddb1780bb46ff8e9b735da3ccf4b0",
"lastmodified_by": [
{
"email_id": "amelia@zylker.com",
"profile_photo": "https://contacts.zoho.com/file?t=user&ID=1306446&fs=thumb",
"user_id": "1306446",
"display_name": "Amelia"
}
],
"status": "active"
},
{
"created_time": "2018-02-06T10:42:26Z",
"role": "COOWNER",
"modified_time_ms": 1546432372068,
"parent_folder_id": "folder",
"collaboration_id": "1252217998103459356",
"last_opened_time": "2018-12-24T12:35:50Z",
"open_url": "https://writer.zoho.com/writer/open/4fv343fa906eb10f443c583d58482632ccedb",
"is_favourite": true,
"type": "document",
"document_id": "4fv343fa906eb10f443c583d58482632ccedb",
"last_opened_time_ms": 1545654950899,
"thumbnail_url": "https://writer.zoho.com/writer/thumbnail/4fv343fa906eb10f443c583d58482632ccedb",
"created_by": "Amelia",
"document_name": "Retrieved documents",
"created_time_ms": 1517913746753,
"modified_time": "2019-01-02T12:32:52Z",
"preview_url": "https://writer.zoho.com/writer/preview/4fv343fa906eb10f443c583d58482632ccedb",
"creator_id": "1306446",
"download_url": "https://writer.zoho.com/api/v1/download/4fv343fa906eb10f443c583d58482632ccedb",
"permalink": "https://docs.zoho.com/file/4fv343fa906eb10f443c583d58482632ccedb",
"lastmodified_by": [
{
"email_id": "amelia@zylker.com",
"profile_photo": "https://contacts.zoho.com/file?t=user&ID=1306446&fs=thumb",
"user_id": "1306446",
"display_name": "Amelia"
}
],
"status": "active"
}
],
"total_count": 144,
"limit": 5
}Show full
Show less