Get Workbook Object

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 specified Workbook.

Method: GET

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

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 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.	–
addWorksheets	Boolean	When set to true, the response includes Worksheets along with the Workbook. This response JSON can be used to add or update the Workbook along with its Worksheets. Any Worksheet that becomes orphaned because of the Workbook update will be removed.	`true` / `false` Default: `false`
addShortcuts	Boolean	When set to true, the response includes shortcuts along with the Workbook. This response JSON can be used to add or update the Workbook along with its shortcuts. Any shortcut that becomes orphaned because of the Workbook update will be removed.	`true` / `false` Default: `false`

Responses

200 Success

{
  "iro": {
    "entityRepositDate": "1776774861573",
    "ownerAppId": "154854747",
    "linkedEntityId": "",
    "type": "WORKBOOK",
    "specific": {
      "worksheets": [
        {
          "owner": "admin",
          "name": "Sheet 1",
          "vizType": "TABLECONTROL",
          "id": "Sheet17767748075688127083031119833531",
          "lastModified": "04/21/2026 18:04:21",
          "accessRights": "1",
          "type": "SHEET",
          "ownerId": "",
          "lastModifiedTimestamp": "1776774861612"
        }
      ],
      "calculatedMeasures": {},
      "dynamicMembers": {},
      "parameters": []
    },
    "folderId": "folder_17754745110577127079056138147986",
    "designSource": "DESIGNER",
    "ownerAppName": "admin",
    "common": {
      "compatibilityVersion": "1",
      "desc": "",
      "tags": ""
    },
    "entityState": "",
    "name": "cte_rolap",
    "isPublic": true,
    "subType": "",
    "repositDate": "04/21/2026 18:04:21 IST",
    "id": "Workbook17767747973146127029072117047065",
    "folderName": "test",
    "accessRights": "1",
    "categoryId": "folder_17754745110577127079056138147986"
  }
}

Status Code	Description

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