Get All Bookmarks in a Collection

Purpose

This API is used to retrieve the details of all bookmarks added within a specific collection, either within a group or for personal use.

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}/collections/{collectionId}

or

Personal Bookmarks:

https://mail.zoho.com/api/links/me/collections/{collectionId}

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 Group

Copiedcurl "https://mail.zoho.com/api/links/groups/84626808/collections/3764869000000009001?limit=2&fields=title,link" \
-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/collections/3764869000000009001?limit=2&fields=title,link" \
-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/collections/3764869000000009001?&after=2&limit=2&fields=title,link"
    },
    "list": [
      {
        "namespaceId": "84626808",
        "link": "https://mail.zoho.com",
        "entityId": "1712123191509110002",
        "title": "https://mail.zoho.com"
      },
      {
        "namespaceId": "84626808",
        "link": "https://repository.zoho.com/",
        "entityId": "1710934555231110002",
        "title": "https://repository.zoho.com/"
      }
    ]
  }
}

Sample Failure Response

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