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

Celonis APIs are divided into three families: Data Integration, Process Intelligence, and Administration

Each of these families has its own overview page in this documentation. These overview pages are divided into the individual APIs that make up the service. The documentation for each API is structured by endpoints. An endpoint is a specific method within an API that does one action and is located at a specific URL.

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 API Essentials chapter.

Summary of the available APIs per family

API Family	Family Member API	API Endpoint Reference
Data Integration	Data Push	OpenAPI Specification
	Data Ingestion	Data Ingestion OpenAPI Specification
	Data Model	Data Model OpenAPI Specification
	Data Job	Data Job OpenAPI Specification
Process Intelligence	Intelligence (Knowledge Model)	Knowledge Model (KM) OpenAPI Specification Schema Discovery: List Knowledge Models Get the details of a Knowledge Model (KM) List the Filters of a KM List the Key Performance Indicators (KPI) of a KM List the Records of a KM Get the Schema of a KM Record Data Query: Retrieve Knowledge Model (KM) data Retrieve Knowledge Model (KM) Record data
		BETA - OData Protocol for Intelligence API Knowledge Model (KM) metadata Knowledge Model (KM) service definition Knowledge Model (KM) service data retrieval
		BETA - Intelligence API Semantic Extensions for 3P Agent Generate OpenAPI Spec from Knowledge Model (KM) metadata Get Knowledge Model (KM) record column statistics Query Knowledge Model (KM) Record Query Knowledge Model (KM)
	Intelligence (Subscription Management)	Subscription OpenAPI Specification: Knowledge Model Trigger Discovery: List the available Trigger(s) of a Knowledge Model (KM) Get KM Trigger Schema Subscription Management: List Subscriptions Create a Subscription to a KM Trigger Delete a Subscription Update a Subscription Pause a Subscription Resume a Subscription (with history) Resume a Subscription (without history) Reconcile a failed Subscription Replay the events of a subscription from a specific offset
	Intelligence (Subscription Management)	Outbound Trigger OpenAPI Specification Consume Webhook Events
	Intelligence (AI Agent)	AI Agent OpenAPI Specification List the Tools of an AI Agent Run a Tool of an AI Agent Chat with an AI Agent
Administration	User Provisioning	SCIM OpenAPI Specification
	Audit Log	Audit Log OpenAPI Specification
	Login History	Login History OpenAPI Specification
	Platform Adoption	Platform Adoption OpenAPI Specification

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.