1Get Worksheet Object

Overview

This API retrieves the specified Worksheet object.

Method: GET

Request URL: {kyvos-url}/rest/v2/worksheets/{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 Worksheet to be retrieved.

Note: If the Worksheet name is provided, the workbookName query parameter must also be specified.

–

Query Parameters

Parameter Name	Type	Description	Possible Values

Parameter Name	Type	Description	Possible Values
by	String	Specifies whether the name-or-id path parameter represents a Worksheet name or ID. `by=name`: Provide the Worksheet name. `by=id`: Provide the Worksheet ID. Default: `name`	`name`, `id`
folderName	String	Name of the folder containing the Worksheet. If the Worksheet is in the root directory, specify [Root]. Note: If neither folderName nor folderId is provided, the Worksheet is treated as a root-level entity.	–
folderId	String	ID of the folder containing the Worksheet.	–
workbookName	String	Name of the Workbook containing the Worksheet. Required when retrieving a Worksheet by name.	–

Responses

200 Success

{
  "iro": {
    "entityRepositDate": "1779867369261",
    "ownerAppId": "Admin",
    "linkedEntityId": "",
    "type": "WORKSHEET",
    "specific": {
      "worksheet": {
        "owner": "Admin",
        "qnaSheet": {
          "theme": {
            "name": "None",
            "id": ""
          },
          "qnaLayout": {
            "associatedWith": "AISPACE",
            "aiSpace": {
              "name": "Retail Superstore",
              "id": "29EB9CB4-28EA-0B20-9C8A-60D202E3403A",
              "folderName": "Admin"
            },
            "view": "",
            "dataMaxRows": "1000",
            "layoutType": "QNA",
            "qnas": {
              "conversationsArr": [
                {
                  "conversationState": {
                    "cardTitle": "Wide Variation in Sales Across Products—Top Sellers Dominate Early Data",
                    "rephrasedQuestion": "What is the total sales for each product name?",
                    "savedOlapLayoutState": {
                      "visualization": {
                        "chartType": "BAR"
                      }
                    }
                  },
                  "requestInfo": {
                    "data": {
                      "nlQuery": "What is the total Sales for each Product Name?"
                    }
                  },
                  "responseInfo": {
                    "data": {
                      "query": "SELECT `product name` AS `product_name`, SUM(`sales`) AS `total_sales` FROM `Admin`.`Order Date` GROUP BY `product name` ORDER BY `product_name`"
                    }
                  }
                }
              ]
            }
          }
        },
        "viewerWidth": "1200",
        "lastModified": "05/27/2026 07:36:09 UTC",
        "accessRights": "1",
        "type": "QNASHEET",
        "ownerId": "Admin",
        "workbookId": "Workbook17798673117657127099050140135946",
        "lastModifiedTimestamp": "1779867369261"
      }
    },
    "folderId": "folder_17782260890263127069099144160433",
    "designSource": "DESIGNER",
    "ownerAppName": "Admin",
    "common": {
      "compatibilityVersion": "1",
      "desc": "",
      "tags": ""
    },
    "name": "Chat Session 1",
    "isPublic": true,
    "subType": "QNASHEET",
    "repositDate": "05/27/2026 07:36:09 UTC",
    "id": "QNASheet17798673267347127081096111972640",
    "folderName": "SA",
    "accessRights": "1",
    "categoryId": "folder_17782260890263127069099144160433"
  }
}

Note: The response above is abbreviated for readability. The actual API response contains additional nested objects and properties.

Status Code	Description

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