Get a Bookmark Details

Purpose

This API is used to retrieve the details of a specific bookmark.

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

For Group :

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

For Personal :

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

Path Parameters

groupId* long
- Specifies the unique ID of the group.
- This parameter can be retrieved from the Get all groups in Bookmarks API.
bookmarkId* long
- Specifies the unique ID of the bookmark.
- This parameter can be retrieved from the Get all bookmarks API.

* - 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/1712123191509110002" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"

Sample Request - For Personal Notes

Copiedcurl "https://mail.zoho.com/api/links/me/1712123191509110002" \
-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": {
    "summary": "https://mail.zoho.com",
    "namespaceId": "84626808",
    "link": "https://mail.zoho.com",
    "entityId": "1712123191509110002",
    "title": "https://mail.zoho.com",
    "collectionId": "3764869000000009001",
    "linkMetaInfo": {
      "linkTitle": "https://mail.zoho.com",
      "linkDescription": "https://mail.zoho.com"
    },
    "collectionName": "category1",
    "isFavorite": "false",
    "tags": []
  }
}

Sample Failure Response

Copied{
  "status": {
    "code": 500,
    "description": "Internal Error"
  },
  "data": {
    "moreInfo": "Requested entity does not exist"
  }
}