Get List of Workbook Shortcuts

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 shortcuts in a Workbook.

Method: GET

Request URL: {kyvos-url}/rest/v2/workbooks/{name-or-id}/shortcuts

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.

–

Path Parameters

Parameter Name	Type	Description	Possible Values

Parameter Name

Type

Description

Possible Values

name-or-id (Required)

String

Name or ID of the Workbook from which the shortcuts are to be retrieved.

Note: If the Workbook name is provided, then either folderName or folderId must also be provided.

–

Query Parameters

Parameter Name	Type	Description	Possible Values

Parameter Name	Type	Description	Possible Values
by	String	Specifies whether the name-or-id parameter should be interpreted as a Workbook name or Workbook ID. If by=name, provide the Workbook name in the name-or-id parameter. If by=id, provide the Workbook ID in the name-or-id parameter. The default value is name.	–
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 will be treated as a root-level entity by default.	–
folderId	String	ID of the folder containing the Workbook.	–
isCompleteDetails	Boolean	Specifies whether the response should include complete information about the shortcuts.	`true` / `false` Default: `false`

Responses

200 Success

{
  "shortcuts": [
    {
      "entityRepositDate": "1779953368042",
      "ownerAppId": "28727",
      "linkedEntityId": "",
      "type": "SHORTCUT",
      "specific": {
        "sourceEntitySubType": "SHEET",
        "sourceEntityType": "WORKSHEET",
        "sourceEntityId": "Sheet17799533678656127078030184635375",
        "sourceEntityName": "MeasureFIlter",
        "entity": {
          "sheet": {
            "...": "Shortcut details omitted for brevity"
          }
        }
      },
      "folderId": "",
      "designSource": "DESIGNER",
      "ownerAppName": "kyvos",
      "common": {
        "compatibilityVersion": "1",
        "desc": "",
        "tags": ""
      },
      "entityState": "",
      "name": "Shortcut 1",
      "isPublic": true,
      "subType": "",
      "repositDate": "05/28/2026 12:59:28 IST",
      "id": "Shortcut17799533680381820950",
      "folderName": "",
      "accessRights": "1",
      "categoryId": ""
    }
  ]
}

Status Code	Description

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