{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/celonis-apis/get-started-with-celonis-apis/","matchPath":"","result":{"data":{"markdownRemark":{"html":"

Get started with Celonis APIs

\n

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.

\n

Reading this documentation

\n

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

\n\n

API Essentials

\n

Install a REST Client

\n

How to install a REST client to access Celonis APIs.

\n

Authentication/Authorization

\n

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

\n

Result Pagination

\n

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

\n

Quotas and Rate Limiting

\n

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 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.

\n

Common Error Messages

\n

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.

","headings":[{"value":"Get started with Celonis APIs","depth":1},{"value":"Reading this documentation","depth":2},{"value":"API Essentials","depth":2},{"value":"Install a REST Client","depth":3},{"value":"Authentication/Authorization","depth":3},{"value":"Result Pagination","depth":3},{"value":"Quotas and Rate Limiting","depth":3},{"value":"Common Error Messages","depth":3}]},"contentItem":{"data":{"lastModified":"2025-08-13T20:04:37.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":false,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"f6b35c31-6392-5eb2-a3c7-c93fc5f9ef9d__redocly content/celonis-apis/get-started-with-celonis-apis/","seo":{"title":"Get started with Celonis APIs","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"celonis-apis/get-started-with-celonis-apis.md","pageBaseUrl":"/celonis-apis/get-started-with-celonis-apis","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Get started with Celonis APIs","id":"get-started-with-celonis-apis"},{"depth":2,"value":"Reading this documentation","id":"reading-this-documentation"},{"depth":2,"value":"API Essentials","id":"api-essentials"},{"depth":3,"value":"Install a REST Client","id":"install-a-rest-client"},{"depth":3,"value":"Authentication/Authorization","id":"authenticationauthorization"},{"depth":3,"value":"Result Pagination","id":"result-pagination"},{"depth":3,"value":"Quotas and Rate Limiting","id":"quotas-and-rate-limiting"},{"depth":3,"value":"Common Error Messages","id":"common-error-messages"}]},"data":{"title":""},"catalogInfo":null,"link":"/celonis-apis/get-started-with-celonis-apis/","sidebarName":"celonis","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}