{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Exploring the schema endpoints","description":"API documentation for Celonis APIs.","siteUrl":"https://developer.celonis.com/","keywords":"celonis developer portal, celonis apis, celonis api reference docs","lang":"en-US","llmstxt":{"hide":false,"description":"Celonis API documentation","sections":[{"title":"API Docs","description":"Available Celonis API Docs","includeFiles":["**/*.md"],"excludeFiles":[]},{"title":"API Specs","description":"All Celonis API specifications","includeFiles":["**/openapi.yaml"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"exploring-the-schema-endpoints","__idx":0},"children":["Exploring the schema endpoints"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This can be considered Part II of the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/process-intelligence-apis/knowledge-model-api/get-started/getting-started"},"children":["Getting Started page"]},". If you haven't read it yet, we"," ","strongly recommend you to do it before proceeding."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In this tutorial we will guide you through the different schema endpoints available in the Knowledge Model API."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"list-of-knowledge-models","__idx":1},"children":["List of Knowledge Models"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["As we saw in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/process-intelligence-apis/knowledge-model-api/get-started/getting-started"},"children":["Getting Started page"]},", you can get the full list of Knowledge Models that you"," ","have access to, creating a request to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://<team>.<cluster>.celonis.cloud/intelligence/api/knowledge-models"]}," (remember"," ","that you need to replace ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<team>"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<cluster>"]}," with your own values)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/knowledge-models.1689be958259b96c9cfa13712cf6bd227d18eab5f371ff290ea005a53a6c66c2.3c53a942.png","alt":"Knowledge Models response"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"list-of-knowledge-model-filters","__idx":2},"children":["List of Knowledge Model Filters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can get the full list of filters that a Knowledge Model has, creating a request to"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://<team>.<cluster>.celonis.cloud/intelligence/api/knowledge-models/<km_id>/filters"]},". For this URL, you will need to"," ","replace the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<km_id>"]}," with the Knowledge Model id that you got from the previous endpoint."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/filters.85c06faa5a32f6bfdef7e2929fdfa7270cdf80395766fbfe608035f07cd63a6d.3c53a942.png","alt":"Knowledge Models filters"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"list-of-knowledge-model-kpis","__idx":3},"children":["List of Knowledge Model KPIs"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Similar to filters, you can also get the KPIs for a given Knowledge Model. To do this, simply append"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/<km_id>/kpis"]}," to the URL you used to get the full list of Knowledge Models, i.e."," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://<team>.<cluster>.celonis.cloud/intelligence/api/knowledge-models/<km_id>/KPIs"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/kpis.77efae7d190e918202ad665818e0743831384086b56b8c831836282eda53ec0e.3c53a942.png","alt":"Knowledge Models KPIs"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"list-of-knowledge-model-records","__idx":4},"children":["List of Knowledge Model Records"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Similar to filters, you can also get the records for a given Knowledge Model. To do this, simply append"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/<km_id>/records"]}," to the URL we used to get the full list of Knowledge Models, i.e."," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://<team>.<cluster>.celonis.cloud/intelligence/api/knowledge-models/<km_id>/records"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/records.ed50237118d3d3e010e7cc82f2fe1cef8a920177aa5c8e2d46ff8a3858788347.3c53a942.png","alt":"Knowledge Models records"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"list-of-record-fields","__idx":5},"children":["List of Record fields"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Finally, you can get a list of all the fields that can be consumed for a record, by appending the id of the record that"," ","you got in the previous endpoint, i.e."," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://<team>.<cluster>.celonis.cloud/intelligence/api/knowledge-models/<km_id>/records/<record_id>"]},". This list"," ","contains Attributes, Augmented Attributes and Flags."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/fields.d49aa8d8cc252732ae8a57cf53f6bdcb5108678ad2a71d323a1e68fbc9995396.3c53a942.png","alt":"Knowledge Models fields"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/process-intelligence-apis/knowledge-model-api/tutorials/learning/retrieve-record-data"},"children":["next tutorial"]}," we will look into how to consume the data for a record."]}]},"headings":[{"value":"Exploring the schema endpoints","id":"exploring-the-schema-endpoints","depth":1},{"value":"List of Knowledge Models","id":"list-of-knowledge-models","depth":2},{"value":"List of Knowledge Model Filters","id":"list-of-knowledge-model-filters","depth":2},{"value":"List of Knowledge Model KPIs","id":"list-of-knowledge-model-kpis","depth":2},{"value":"List of Knowledge Model Records","id":"list-of-knowledge-model-records","depth":2},{"value":"List of Record fields","id":"list-of-record-fields","depth":2}],"frontmatter":{"seo":{"title":"Exploring the schema endpoints"}},"lastModified":"2026-02-26T22:05:33.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/process-intelligence-apis/knowledge-model-api/tutorials/learning/exploring-schema","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}