Get Workbooks From Folder

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 a list of Workbooks from the specified folder.

Method: GET

Request URL: {kyvos-url}/rest/v2/workbooks/folders/{foldername-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
foldername-or-id (Required)	String	Name or ID of the folder from which the Workbook list will be retrieved.	–

Query Parameters

Parameter Name	Type	Description	Possible Values

Parameter Name	Type	Description	Possible Values
by	String	Specifies whether the foldername-or-id parameter should be interpreted as a Workbook folder name or Workbook folder ID. If by=name, provide the Workbook folder name in the path parameter. If by=id, provide the Workbook folder ID in the path parameter. The default value is name.	–
owner	String	Filters entities by owner (the user who created the entity) name.	–
tags	String	Filters Workbooks by tags. This filter applies only to Workbooks that contain a single tag.	–
searchText	String	Filters Workbooks by name. All Workbooks whose names contain the specified text are included in the response, irrespective of case.	–
modifiedAfter	String	Filters Workbooks to include only those modified after the specified Unix timestamp.	–
modifiedBefore	String	Filters Workbooks to include only those modified before the specified Unix timestamp.	–
count	Number	Specifies the maximum number of records returned in the response. Note: The count parameter is applied only when its value is a positive number. If the value is negative, all available records are returned. Default: `500`	–
lastEntityName	String	Returns only the entities that occur after the specified entity name. Entities before the specified name are excluded.	–
lastEntityId	String	Returns only the entities that occur after the specified entity ID. Entities before the specified ID are excluded.	–

Responses

200 Success

{
  "workbooks": [
    {
      "owner": "admin",
      "name": "cte_rolap",
      "id": "Workbook17767747973146127029072117047065",
      "lastModified": "04/21/2026 18:04:21 IST",
      "accessRights": "1",
      "ownerId": "154854747",
      "lastModifiedTimestamp": "1776774861573"
    },
    {
      "owner": "automationdev",
      "name": "Untitled Workbook",
      "id": "Workbook17754745156203127039075190828161",
      "lastModified": "04/14/2026 18:54:26 IST",
      "accessRights": "1",
      "ownerId": "244573616",
      "lastModifiedTimestamp": "1776173066563"
    }
  ]
}

Status Code	Description

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