{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Get started with Celonis APIs","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":"get-started-with-celonis-apis","__idx":0},"children":["Get started with Celonis APIs"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Every Celonis customer has access to a range of APIs that provide access to ingest data into Celonis, consume process intelligence from Celonis, and administer the Celonis team."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"reading-this-documentation","__idx":1},"children":["Reading this documentation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each API endpoint in this documentation is described using several parts:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["The HTTP method."]},"  Includes  ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]},",  ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]},",  ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]},",  ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]},",  and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["The base path."]},"  All URLs referenced in the documentation have the base path ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://{team_domain}.{realm}.celonis.cloud"]},". This base path goes ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["before"]}," the endpoint path."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["The endpoint path."]},"  The endpoint path is resource-oriented. For example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/intelligence/api/knowledge-models/{km-id}/records/{record-id}"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required parameters."]},"  These parameters must be included in a request. In the example above,  ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{km-id}"]},"  and  ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{record-id}"]},"  are required parameters representing the resources to be accessed. In a request, you will replace the placeholders with real values."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Optional parameters."]},"  These parameters can be included in a request to customize the query. Query parameters are added to the end of the URL with  ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://en.wikipedia.org/wiki/Query_string"},"children":["query string encoding"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["A token scope."]},"  If an API endpoint requires a ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/celonis-apis/auth#authorization"},"children":["token scope"]}," that the default access token does not have, the token scope will be listed instead."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Code examples."]},"  Each endpoint has example requests in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"http://curl.haxx.se/"},"children":["cURL"]}," format and in the following programming languages: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.w3schools.com/js/default.asp"},"children":["JavaScript"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.w3schools.com/java/default.asp"},"children":["Java"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.w3schools.com/python/default.asp"},"children":["Python"]},", and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.w3schools.com/php/default.asp"},"children":["PHP"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Essentials."]}," Features applicable to all APIs such as Authentication/Authorization, Pagination, Quotas and Rate limiting, and Error Message Standardization are handled in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/celonis-apis/get-started-with-celonis-apis#api-essentials"},"children":["API Essentials"]}," section below."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-essentials","__idx":2},"children":["API Essentials"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"_","__idx":3},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/celonis-apis/rest-client"},"children":["Install a REST Client"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["How to ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/celonis-apis/rest-client"},"children":["install a REST client"]}," to access Celonis APIs."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"_-1","__idx":4},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/celonis-apis/auth"},"children":["Authentication/Authorization"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The user security and permissions ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/celonis-apis/auth"},"children":["framework"]}," to access Celonis platform via Celonis APIs."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"_-2","__idx":5},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/celonis-apis/pagination"},"children":["Result Pagination"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When you call a Celonis API method to retrieve a collection of objects, they are usually returned in portions. Check out the details on ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/celonis-apis/pagination"},"children":["pagination in API methods"]},", including how to use them and which methods follow the pattern."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"_-3","__idx":6},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/celonis-apis/rate-limiting"},"children":["Quotas and Rate Limiting"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Celonis Platform features and APIs rely on rate limits to help provide a predictable experience for users. The details of how and when rate limiting works differs between API families and features. This ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/celonis-apis/rate-limiting"},"children":["article"]}," gives an overview of the rate limits you're likely to encounter for Celonis API families and notes how the limits apply to each family."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"_-4","__idx":7},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/celonis-apis/api-reference/common-error-catalog"},"children":["Common Error Messages"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This article identifies some of the error codes and messages that Celonis APIs return. Specifically, ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/celonis-apis/api-reference/common-error-catalog"},"children":["the errors listed here"]}," are in the global, or default, domain for Celonis APIs. Many APIs also define their own domains, which identify API-specific errors that are not in the global domain."]}]},"headings":[{"value":"Get started with Celonis APIs","id":"get-started-with-celonis-apis","depth":1},{"value":"Reading this documentation","id":"reading-this-documentation","depth":2},{"value":"API Essentials","id":"api-essentials","depth":2},{"value":"","id":"_","depth":3},{"value":"","id":"_-1","depth":3},{"value":"","id":"_-2","depth":3},{"value":"","id":"_-3","depth":3},{"value":"","id":"_-4","depth":3}],"frontmatter":{"seo":{"title":"Get started with Celonis APIs"}},"lastModified":"2026-02-26T22:05:33.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/celonis-apis/get-started-with-celonis-apis","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}