1Get Related Entities

Overview

This API retrieves entities related to a specified entity.

Method: GET

Request URL: {kyvos-url}/rest/v2/entities/{name-or-id}/related-entities

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

name-or-id (Required)

String

Name or ID of the Entity whose Related Entities need to be retrieved.

Note: If the Entity name is provided, then folderName must also be provided.

–

Query Parameters

Parameter Name	Type	Description	Possible Values

Parameter Name	Type	Description	Possible Values
by	String	Specifies whether the name-or-id parameter should be interpreted as an Entity name or Entity ID. If by=name, provide the Entity name in the name-or-id parameter. If by=id, provide the Entity ID in the name-or-id parameter. The default value is name.	–
folderName	String	Name of the folder containing the Entity. If the Entity is present in the root directory, specify [Root]. Note: If folderName is not provided, the Entity will be treated as a root-level by default.	–
type (Required)	String	Type of the Entity whose related entities need to be retrieved.	QUERY, ANALYTICAL, RELATIONSHIP, WORKBOOK, WORKSHEET, SPACE
subType	String	Sub type of the Entity.	DASHBOARD, SHEET
relationshipType	String	Type of relationship used to filter the related entities.	BOTH: Returns both source and dependent entities. OUTGOING: Returns only the dependent entities. INCOMING: Returns only the source entities. Default: BOTH
relationshipDepth	String	Depth of relationship traversal. Must be a valid integer representing how many levels deep to search for related entities.	“1”: Returns the immediate entities. ”-1”: Returns all related entities. Default: "1"

Responses

200 Success

{
    "17387444543586127083090135185410": {
        "owner": "bi admin",
        "lastModifiedDate": "04/09/2026 18:29:11",
        "ownerAppId": "375209034",
        "folderOwnerAppId": "361661441",
        "name": "Range table",
        "subType": "REGISTERED",
        "accessRights": 1,
        "folderName": "SampleData",
        "type": "QUERY",
        "folderId": "folder_17290024226501127073026128311690",
        "folderOwner": "bi admin",
        "out": [
            "17387445433377127086016125296531",
            "17859331752524127014097180667327"
        ]
    },
    "Sheet17859331005724127072035184336689": {
        "workbookName": "range",
        "owner": "kyvos admin",
        "lastModifiedDate": "08/05/2026 18:02:06",
        "ownerAppId": "402343863",
        "folderOwnerAppId": "402343863",
        "type": "WORKSHEET",
        "workbookId": "Workbook17859329374273127083017198173465",
        "folderId": "folder_17780469646741127090010137614002",
        "workookOwnerAppId": "402343863",
        "workookOwner": "kyvos admin",
        "name": "Sheet 2",
        "subType": "SHEET",
        "accessRights": 1,
        "folderName": "account",
        "folderOwner": "kyvos admin"
    },
    "Sheet17859331129124127044065167840802": {
        "workbookName": "range",
        "owner": "data admin",
        "lastModifiedDate": "08/05/2026 18:02:06",
        "ownerAppId": "402343863",
        "folderOwnerAppId": "402343863",
        "type": "WORKSHEET",
        "workbookId": "Workbook17859329374273127083017198173465",
        "folderId": "folder_17780469646741127090010137614002",
        "workookOwnerAppId": "402343863",
        "workookOwner": "data admin",
        "name": "Sheet 3",
        "subType": "SHEET",
        "accessRights": 1,
        "folderName": "range",
        "folderOwner": "data admin"
    },
    "17387445433377127086016125296531": {
        "owner": "kyvos",
        "lastModifiedDate": "04/09/2026 18:29:12",
        "ownerAppId": "375209034",
        "folderOwnerAppId": "361661441",
        "name": "Range table 2",
        "subType": "",
        "accessRights": 1,
        "folderName": "SampleData",
        "type": "DRD_OBJECT",
        "folderId": "folder_17290042399793127093041114792741",
        "folderOwner": "kyvos",
        "out": [
            "17387365940065127087052144185143"
        ]
    },
    "17859331752524127014097180667327": {
        "owner": "kyvos",
        "lastModifiedDate": "08/05/2026 18:02:55",
        "ownerAppId": "375209034",
        "folderOwnerAppId": "375209034",
        "name": "Range table 3",
        "subType": "",
        "accessRights": 1,
        "folderName": "SampleData",
        "type": "DRD_OBJECT",
        "folderId": "folder_17290042399793127093041114792741",
        "folderOwner": "kyvos"
    },
    "17387365940065127087052144185143": {
        "owner": "kyvos",
        "lastModifiedDate": "04/09/2026 22:09:02",
        "ownerAppId": "375209034",
        "folderOwnerAppId": "375209034",
        "modelType": "BASE",
        "type": "ANALYTICAL",
        "folderId": "folder_17387365785848127012084133144495",
        "out": [
            "Sheet17859331005724127072035184336689",
            "Sheet17859331129124127044065167840802"
        ],
        "name": "Range1 NoSpark",
        "subType": "CUBE",
        "accessRights": 1,
        "folderName": "Range",
        "folderOwner": "kyvos"
    }
}

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.