Search documentation
karat

+

K

User Documentation ↗

List Ontologies

GET/api/v1/ontologies

Lists the Ontologies visible to the current user.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:ontologies-read.

Response body

ListOntologiesResponse
object

Success response.

Hide child attributes

Hide child attributes

data
list<Ontology>
optional

The list of Ontologies the user has access to.

Show child attributes

Show child attributes

Examples

Request

Copied!
1 2 3 curl \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v1/ontologies"

Response

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 { "data": [ { "apiName": "default-ontology", "displayName": "Ontology", "description": "The default ontology", "rid": "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" }, { "apiName": "shared-ontology", "displayName": "Shared ontology", "description": "The ontology shared with our suppliers", "rid": "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" } ] }