Get All Bookmarks

Purpose

This API is used to retrieve the details of all bookmarks added within a group or all personal bookmarks added by you.

OAuth Scope

Use the scope

ZohoMail.links.ALL (or) ZohoMail.links.READ

to generate the Authtoken.

ALL - Grants full access to links.

READ - Grants access to read links.

Request URL

Method: GET

Group Bookmarks:

https://mail.zoho.com/api/links/groups/{groupId}

or

Personal Bookmarks:

https://mail.zoho.com/api/links/me

Path Parameters

Query Parameters

  • fields string (comma-separated list)
    • This parameter specifies the details associated with the bookmark that you wish to retrieve.
    • Allowed values:
      • title
        • This parameter specifies the title of the bookmark.
      • summary
        • This parameter specifies the summary of the bookmark.
      • link
        • This parameter specifies the link.
      • linkMetaInfo
        • This parameter specifies the metadata associated with the link.
      • collectionName
        • This parameter specifies the collection name with which the bookmarks are associated with.
    • Example: fields=title,summary,link
    • If no field is entered, all the details will be retrieved.
  • after int
    • This parameter specifies from which retrieval has to be done.
    • Allowed values : 1 to (Number of Bookmarks)
  • limit int
    • This parameter specifies the number of bookmarks to retrieve.
    • Allowed values : 1 to 399.
    • Default value : 20.
  • isPrev boolean
    • This parameter specifies whether the retrieval should be in ascending or descending order based on created time.
    • Allowed values :
      • true - To retrieve in ascending order.
      • false - To retrieve in descending order.
    • Default value : false.

 

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request - For Groups

Copiedcurl "https://mail.zoho.com/api/links/groups/84626808?limit=2" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"

Sample Request - For Personal

Copiedcurl "https://mail.zoho.com/api/links/me?limit=2" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"

Sample Success Response

Copied{
   "status": {
       "code": 200,
       "description": "success"
   },
   "data": {
       "pagination": {
           "next": "https://mail.zoho.com/api/links/groups/84626808?&after=2&limit=2"
       },
       "list": [
           {
               "summary": "Link Description",
               "namespaceId": "84626808",
               "link": "https://www.zoho.com",
               "entityId": "1712055380477110001",
               "title": "zoho link",
               "collectionId": "3764869000000006003",
               "linkMetaInfo": {
                   "linkTitle": "Zoho | Cloud Software Suite for Businesses",
                   "linkImage": "https://www.zohowebstatic.com/sites/zweb/images/zoho_general_pages/zh-homev2-banner.png"
               },
               "collectionName": "General",
               "isFavorite": "false",
               "tags": []
           },
           {
               "summary": "Link Description",
               "namespaceId": "84626808",
               "link": "https://www.zoho.com",
               "entityId": "1712055358708110001",
               "title": "zoho link",
               "collectionId": "3764869000000006003",
               "

Sample Failure Response

Copied{
   "data": {
       "errorCode": "PATTERN_NOT_MATCHED",
       "moreInfo": "fields Input does not match the given pattern"
   },
   "status": {
       "code": 400,
       "description": "Invalid Input"
   }
}