Get All Worksheets

This REST API returns information about the worksheets contained in a workbook.

REST API

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

Request parameters

Parameter Name	Type	Location	Description
name	string	path	The name of the Excel document.
folder	string	query	The folder that contains the document.
storageName	string	query	The name of the storage to use.

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

You can use the cURL command‑line tool to access Aspose.Cells Cloud services. The example below demonstrates a GET request to retrieve the worksheets.

Request

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

Response

{
  "Worksheets": {
    "WorksheetList": [
      {
        "link": {
          "Href": "/Sheet1",
          "Rel": "self"
        }
      },
      {
        "link": {
          "Href": "/Sheet2",
          "Rel": "self"
        }
      }
    ],
    "link": {
      "Href": "https://api.aspose.cloud/v3.0/cells/myWorkbook.xlsx/worksheets",
      "Rel": "self"
    }
  },
  "Code": "200",
  "Status": "OK"
}

Error Handling

Typical HTTP status codes returned by this endpoint:

Code	Meaning	Description
400	Bad Request	Missing required parameter (e.g., `name`).
401	Unauthorized	Invalid or missing JWT token.
404	Not Found	Specified workbook does not exist.
500	Internal Server Error	Unexpected server condition.

Error responses are returned in JSON format, for example:

{
  "Code": "401",
  "Message": "Invalid access token."
}

Cloud SDK Family

Using an SDK is the best way to speed up development. An SDK handles low‑level details so you can focus on your project tasks. Please check out 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:

Convert Worksheet to PDF, PNG, CSV & More – Aspose.Cells Cloud API