Get Datasets List 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 the list of Datasets from a specific folder.

Method: GET

Request URL: {kyvos-url}/rest/v2/datasets/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 Datasets need to 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 Dataset folder name or Dataset folder ID. If by=name, provide the folder name in the foldername-or-id parameter. If by=id, provide the folder ID in the foldername-or-id parameter. The default value is name.	–
owner	String	Filters Datasets by the owner (the user who created the entity).	–
tags	String	Filters Datasets using tags. This filter works only when the entity contains a single tag.	–
searchText	String	Filters Datasets by name. All Datasets whose names contain the specified text are returned, regardless of case.	–
modifiedAfter	String	Returns Datasets modified after the specified Unix timestamp.	–
modifiedBefore	String	Returns Datasets modified before the specified Unix timestamp.	–
count	Number	Limits the 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 Datasets that appear after the specified entity name.	–
lastEntityId	String	Returns only the Datasets that appear after the specified entity ID.	–

Responses

200 Success

{
    "registeredFiles":[
        {
            "owner":"Admin",
            "name":"Order Date",
            "id":"15330142847572127083069172553064",
            "lastModified":"05/11/2026 16:56:34 IST",
            "accessRights":"1",
            "ownerId":"244573616",
            "lastModifiedTimestamp":"1778498794206"
        },
        {
            "owner":"Admin",
            "name":"Product",
            "id":"15330140041630127043070144312748",
            "lastModified":"05/11/2026 16:56:34 IST",
            "accessRights":"1",
            "ownerId":"244573616",
            "lastModifiedTimestamp":"1778498794428"
        }
    ]
}

Status Code	Description

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