Get Dataset Relationships 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 Dataset Relationships from a specific folder.

Method: GET

Request URL: {kyvos-url}/rest/v2/dataset-relationships/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 you want to retrieve the list of Dataset Relationships.	–

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 Relationship folder name or a Dataset Relationship folder ID. If by=name, provide the Dataset Relationship folder name in the foldername-or-id parameter. If by=id, provide the Dataset Relationship folder ID in the foldername-or-id parameter. The default value is name.	–
owner	String	Filters entities by owner (the user who created the entity).	–
tags	String	Filters entities by tags. This filter works only when the entity contains a single tag.	–
searchText	String	Filters entities by their names. All entities whose names contain the searched text are included in the result, irrespective of case.	–
modifiedAfter	String	Returns entities modified after the specified Unix timestamp.	–
modifiedBefore	String	Returns entities 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 positive. If a negative value is provided, all available records are returned. Default: `500`.	–
lastEntityName	String	Returns only entities appearing after the specified entity name. Used for pagination.	–
lastEntityId	String	Returns only entities appearing after the specified entity ID. Used for pagination.	–

Responses

200 Success

{
  "datasetRelationships": [
    {
      "owner": "Admin",
      "name": "admin Relationship",
      "id": "17504178000665127098015115855971",
      "lastModified": "01/12/2026 17:06:02 IST",
      "accessRights": "1",
      "ownerId": "398949229",
      "lastModifiedTimestamp": "1768217762304"
    },
    {
      "owner": "Kyvos",
      "name": "kyvos Relationship copy 1",
      "id": "17533423946148127025075120472382",
      "lastModified": "01/12/2026 17:06:02 IST",
      "accessRights": "1",
      "ownerId": "398949229",
      "lastModifiedTimestamp": "1768217762335"
    }
  ]
}

Status Code	Description

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