Get All Hyperlinks – Aspose.Cells Cloud REST API

This REST API retrieves all hyperlinks from a specific worksheet in an Excel workbook.

REST API

GET https://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/hyperlinks

Request parameters

Parameter Name	Type	Location	Required	Default	Description
name	string	path	Yes	–	Name of the Excel document.
sheetName	string	path	Yes	–	Name of the worksheet.
folder	string	query	No	–	Folder that contains the document.
storageName	string	query	No	–	Name of the storage service to use.

The OpenAPI Specification defines a publicly accessible programming interface and lets you perform REST interactions directly from a web browser.

You can use the cURL command‑line tool to access Aspose.Cells web services easily. The example below shows how to call the API with cURL.

Request

curl -v "https://api.aspose.cloud/v3.0/cells/test.xlsx/worksheets/Sheet1/hyperlinks" \
  -X GET \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <jwt token>"

Response

{
  "Hyperlinks": {
    "Count": 4,
    "HyperlinkList": [
      {
        "link": {
          "Href": "/0",
          "Rel": "self",
          "Title": null,
          "Type": null
        }
      },
      {
        "link": {
          "Href": "/1",
          "Rel": "self",
          "Title": null,
          "Type": null
        }
      },
      {
        "link": {
          "Href": "/2",
          "Rel": "self",
          "Title": null,
          "Type": null
        }
      },
      {
        "link": {
          "Href": "/3",
          "Rel": "self",
          "Title": null,
          "Type": null
        }
      }
    ],
    "link": null
  },
  "Code": 200,
  "Status": "OK"
}

The JSON response contains a Hyperlinks object.

Count – total number of hyperlinks in the worksheet.
HyperlinkList – an array where each item holds a link object. The Href property stores the hyperlink address, while Rel, Title, and Type provide additional metadata (often null for simple links).

Error Responses

HTTP Code	Reason	Example Body
400	Bad Request – missing or invalid parameters.	`{ "Code":"400", "Message":"Invalid parameter value." }`
401	Unauthorized – missing or invalid JWT token.	`{ "Code":"401", "Message":"Access token is missing or invalid." }`
404	Not Found – workbook or worksheet does not exist.	`{ "Code":"404", "Message":"File not found." }`
500	Internal Server Error – unexpected server failure.	`{ "Code":"500", "Message":"An unexpected error occurred." }`

Cloud SDK Family

Using an SDK is the fastest way to integrate this functionality. SDKs handle low‑level details, allowing you to focus on your business logic. Please check the GitHub repository for a complete list of Aspose.Cells Cloud SDKs.

The following code examples demonstrate how to call Aspose.Cells web services using various SDKs:

Add Hyperlink to Worksheet