Get Worksheet Listing

This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here.

This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here.

Overview

This API retrieves the list of Worksheets within a specified Workbook.

Method: GET

Request URL: {kyvos-url}/rest/v2/worksheets

Authorization

API Key: `sessionid`

This method authenticates requests using a session ID which acts like an API key.

BasicAuth: HTTP Authorization Scheme

This method authenticates requests using a username and password sent in the HTTP Authorization header.

Headers

Header Name	Type	Description	Possible Values

Header Name	Type	Description	Possible Values
sessionid	String	The session ID is the token received from the Login API. Note: Session ID is required for token-based authentication.	–

Query Parameters

Parameter Name	Type	Description	Possible Values

Parameter Name	Type	Description	Possible Values
folderName	String	Name of the folder containing the Workbook. If the Workbook is present in the root directory, specify [Root]. Note: If neither folderName nor folderId is provided, the Workbook is treated as a root-level entity by default.	–
folderId	String	ID of the folder containing the Workbook.	–
workbookName	String	Name of the Workbook for which the Worksheet listing needs to be retrieved. Note: Either workbookName or workbookId must be provided.	–
workbookId	String	ID of the Workbook for which the Worksheet listing needs to be retrieved.	–
worksheetType	String	Type of the Worksheets to be retrieved.	`SHEET`, `DASHBOARD`, `QNASHEET`

Responses

200 Success

{
  "worksheets": [
    {
      "owner": "admin",
      "name": "HighlightingAndTopn",
      "description": "desc test",
      "vizType": "BAR",
      "id": "Sheet17799533678707127098053170330551",
      "lastModified": "05/28/2026 17:07:20",
      "accessRights": "1",
      "type": "SHEET",
      "ownerId": "",
      "lastModifiedTimestamp": "1779968240791",
      "tags": "tag;$;test"
    },
    {
      "owner": "admin",
      "name": "MeasureFIlter",
      "description": "",
      "vizType": "BAR",
      "id": "Sheet17799533678656127078030184635375",
      "lastModified": "05/28/2026 16:57:49",
      "accessRights": "1",
      "type": "SHEET",
      "ownerId": "",
      "lastModifiedTimestamp": "1779967669981",
      "tags": ""
    }
  ]
}

Status Code	Description

Status Code	Description
401	Authorization information is missing or invalid.
404	No matching record found.
500	Internal Server Error