Get Semantic Models 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 fetches the list of Semantic Models stored in a specific folder.

Method: GET

Request URL: {kyvos-url}/rest/v2/semantic-models/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 the Semantic Model list will 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 Semantic Model folder name or Semantic Model folder ID. If by=name, provide the folder name in the path parameter. If by=id, provide the folder ID in the path parameter. The default value is name.	–
fetchProcessedStatus	Boolean	Specifies whether the processed status of Semantic Models should be included in the response.	`true` / `false` Default: false.
queryableModelsOnly	Boolean	Retrieves only those Semantic Models on which queries can be executed.	`true` / `false` Default: false.
owner	String	Filters Semantic Models by owner (the user who created the entity).	–
tags	String	Filters Semantic Models by tags. This filter applies only to Semantic Models containing at least one tag.	–
searchText	String	Filters Semantic Models by name. All Semantic Models whose names contain the specified text are included in the response, irrespective of case.	–
modifiedAfter	String	Filters Semantic Models modified after the specified Unix timestamp.	–
modifiedBefore	String	Filters Semantic Models modified before the specified Unix timestamp.	–
count	Number	Specifies the maximum number of records returned in the response. Note: The `count` parameter is applied only when its value is positive. 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

{
    "semanticModels":[
        {
            "owner":"admin",
            "name":"account1",
            "businessContext":"",
            "queryingContext":"",
            "id":"73EE763B-07B2-7951-6B41-E362A118A9DF",
            "lastModified":"05/22/2026 17:46:32 IST",
            "accessRights":1,
            "ownerId":409021709,
            "lastModifiedTimestamp":1779452192356,
            "allowRawDataQuery":false
        },
        {
            "owner":"admin",
            "name":"account2",
            "businessContext":"",
            "queryingContext":"",
            "id":"33JD684H-12AB-GH56-78JN-GH64KOSU03",
            "lastModified":"06/22/2026 17:26:12 IST",
            "accessRights":1,
            "ownerId":409021709,
            "lastModifiedTimestamp":1779452250606,
            "allowRawDataQuery":false
        }
    ]
}

Status Code	Description

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