1Get Workbook Listing

Overview

This API retrieves a list of Workbooks and their associated folders from the root directory.

Method: GET

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

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
show	String	Controls the types of objects returned in the response.	all – Returns both Folders and Workbooks from the root directory. list – Returns only Workbooks from the root directory. folders – Returns only Folders. Default: `all`
owner	String	Filters Workbooks by owner (the user who created the Workbook) 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. This parameter is applicable only when show=list or show=folders. Note: If the value is negative, all available records are returned.	Default: `500`
lastEntityName	String	Returns only the entities occurring after the specified entity name.	–
lastEntityId	String	Returns only the entities occurring after the specified entity ID.	–

Responses

200 Success

{
  "workbooks": [
    {
      "owner": "Admin",
      "name": "AdvCopy",
      "id": "CA84406E-7F46-4120-F2CB-8B61BDDB6836",
      "lastModified": "05/08/2026 12:03:47 IST",
      "accessRights": "1",
      "ownerId": "402343863",
      "lastModifiedTimestamp": "1778222027389"
    },
    {
      "owner": "Admin",
      "name": "sales",
      "id": "Workbook17747895077687127088033166655740",
      "lastModified": "04/15/2026 17:53:09 IST",
      "accessRights": "1",
      "ownerId": "402343775",
      "lastModifiedTimestamp": "1776255789022"
    }
  ],
  "folders": [
    {
      "owner": "Admin1",
      "name": "admin test",
      "id": "folder_17787417423691127096058115427139",
      "lastModified": "05/14/2026 12:25:42 IST",
      "accessRights": "1",
      "ownerId": "388054466"
    },
    {
      "owner": "Admin1",
      "name": "Admin Testing",
      "id": "folder_17758126542483127052067114392184",
      "lastModified": "04/17/2026 17:47:25 IST",
      "accessRights": "1",
      "ownerId": "244643091"
    }
  ]
}

Status Code	Description

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