Get Folders List

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 folders available in the system. It also supports filtering folders based on entity type, folder name, and folder ID.

Method: GET

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

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
folderNames	String	Comma-separated list of Folder names used to filter the Folder results.	–
folderIds	String	Comma-separated list of Folder IDs used to filter the Folder results.	–
entityType (Required)	String	Type of entity for which the Folder list is to be retrieved.	`RDATASET`, `DATASETRELATIONSHIP`, `SMODEL`, `SPACE`, `WORKBOOK`
separator	String	Delimiter used to separate multiple Folder names or Folder IDs in the request.	–

Note: The HTML uses the parameter name seperator. The correct spelling is separator.

Responses

200 Success

{
  "folders": [
    {
      "entityType": "WORKBOOK",
      "entitySubType": "",
      "name": "Account folder",
      "id": "folder_17787417423691127096058115427139",
      "privilege": "",
      "userId": "388054466",
      "desc": ""
    },
    {
      "entityType": "WORKBOOK",
      "entitySubType": "",
      "name": "Order Date",
      "id": "folder_17758126542483127052067114392184",
      "privilege": "",
      "userId": "244643091",
      "desc": ""
    }
  ]
}

Status Code	Description

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