GET - All Bookmarks
Purpose
This API is used to retrieve the details of all the bookmarks.
Request URL
Group Bookmark
https://mail.zoho.com/api/links/groups/<groupid>
Personal Bookmark
https://mail.zoho.com/api/links/me
Request Parameters
Parameter | Data Type | Allowed Values | Description |
GroupID* | Long | The unique identifier used for groups in the organization | |
limit | Integer | 1 - 499 | The number of bookmarks that you would like to retrieve |
after | Integer | 1 - maximum number of bookmarks | The bookmark number from which the retrieval has to be done |
fields | String |
(separated by comma) | The details associated with the bookmark that you wish to retrieve. (If no field is entered, all the details will be retrieved.) |
* - Mandatory parameters
Response Codes
Please refer Response Codes.
Group Bookmark
Sample Request
Copiedhttps://mail.zoho.com/api/links/groups/53658048?limit=5
Sample Response
Copied{
"status": {
"code": 200,
"description": "success"
},
"data": {
"pagination": {
"next": "http://mail.zoho.com/api/links/groups/36902612?after=1"
},
"list": [
{
"namespaceId": "36902612",
"entityId": "2866449000001798007",
"collectionId": "2866449000001749004",
"collectionName": "Website design",
"title": "layout 1",
"summary": "Layout for homepage ",
"link": "https://www.website.com/website-templates/all/",
"linkMetaInfo": {
"linkFavIconUrl": "https://www.website.com/website-templates/all/",
"linkTitle": "https://www.website.com/website-templates/all/",
"linkDescription": "Design layout for homepage",
"linkImage": "https://www.website.com/website-templates/all/"
},
"isFavorite": "false"
},
{
"namespaceId": "36902612",
"entityId": "2866449000001814006",
"collectionId": "2866449000001749004",
"collectionName": "Reference",
"summary": "How to start a blog",
"link": "https://blog.hubspot.com/marketing/how-to-start-a-blog",
"linkMetaInfo": {
"linkTitle": "https://blog.hubspot.com/marketing/how-to-start-a-blog",
"linkDescription": "https://blog.hubspot.com/marketing/how-to-start-a-blog"
},
"title": "Pointers to write a good blog",
"isFavorite": "false"
}
]
}
}
Personal Bookmark
Sample Request
Copiedhttps://mail.zoho.com/api/links/me?limit=5
Sample Response
Copied{
"status": {
"code": 200,
"description": "success"
},
"data": {
"pagination": {
"next": "http://mail.zoho.com/api/links/groups/36902612?after=1"
},
"list": [
{
"namespaceId": "36902612",
"entityId": "2866449000001798007",
"collectionId": "2866449000001749004",
"collectionName": "Website design",
"title": "layout 1",
"summary": "Layout for homepage ",
"link": "https://www.website.com/website-templates/all/",
"linkMetaInfo": {
"linkFavIconUrl": "https://www.website.com/website-templates/all/",
"linkTitle": "https://www.website.com/website-templates/all/",
"linkDescription": "Design layout for homepage",
"linkImage": "https://www.website.com/website-templates/all/"
},
"isFavorite": "false"
},
{
"namespaceId": "36902612",
"entityId": "2866449000001814006",
"collectionId": "2866449000001749004",
"collectionName": "Reference",
"summary": "How to start a blog",
"link": "https://blog.hubspot.com/marketing/how-to-start-a-blog",
"linkMetaInfo": {
"linkTitle": "https://blog.hubspot.com/marketing/how-to-start-a-blog",
"linkDescription": "https://blog.hubspot.com/marketing/how-to-start-a-blog"
},
"title": "Pointers to write a good blog",
"isFavorite": "false"
}
]
}
}