Get Started with Celonis APIs

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. Read on to learn the basics about how to use them to make magic.

Reading this documentation

Each API endpoint in this documentation is described using several parts:

• The HTTP method. Includes GET , POST , PUT , PATCH , DELETE .
• The base path. All URLs referenced in the documentation have the base path https://{team_domain}.{realm}.celonis.cloud . This base path goes before the endpoint path.
• The endpoint path. The end-point path is resource-oriented. For example, /intelligence/api/knowledge-models/{km-id}/records/{record-id} .
• Required parameters. These parameters must be included in a request. In the example above, {km-id} and {record-id} are required parameters representing the resources to be accessed. In a request, you will replace the placeholders with real values.
• 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 query string encoding .
• A token scope. If an API endpoint requires a token scope that the default access token does not have, this scope will be listed.
• Code examples. Each endpoint has example requests in cURL format and in the following programming languages: JavaScript , Java , Python , PHP .
• API Essentials. Features applicable to all APIs like Authentication/Authorization, Pagination, Quotas and Rate limiting, Error Message Standardization, etc. are handled separately in the API Essentials chapter.

API Essentials

Install a REST Client

How to install a REST client to access Celonis APIs.

Authentication/Authorization

The user security and permissions framework to access Celonis platform via Celonis APIs.

Result Pagination

When you call a Celonis API method to retrieve a collection of objects, usually they're returned to you in portions. Check out details on pagination in API methods, including how to use them and which methods follow the pattern.

Quotas and Rate Limiting

Celonis platform features and APIs rely on rate limits to help provide a predictably pleasant experience for users. The details of how and when rate limiting works differs between API families and features. This article gives an overview of the rate limits you're likely to encounter for Celonis API families, and then notes how the limits apply to each family.

Common Error Messages

This article identifies some of the error codes and messages that Celonis APIs return. Specifically, 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.