{"componentChunkName":"component---src-templates-redoc-operation-js","path":"/celonis-apis/audit-log-api/openapi/openapi-external/overview/","result":{"data":{"contentItem":{"type":"redoc-info","link":"/celonis-apis/audit-log-api/openapi/openapi-external/overview/","data":{"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.1\",\"info\":{\"description\":\"This is the documentation for the Audit Log API, that allows querying on audit logs in an EMS team. The API supports multiple methods of authentication:<br/> - (preferred method) Via OAuth 2.0 token with scope <tt>audit.log:read</tt>, passed in an HTTP header like this: <tt>Authorization: Bearer TOKEN</tt><br/> - Via Application keys, passed in an HTTP header like this: <tt>Authorization: AppKey APPLICATION_KEY</tt><br/> - Via API keys, passed in an HTTP header like this: <tt>Authorization: Bearer API_KEY</tt><br/><br/>Please see [this help page](https://docs.celonis.com/en/using-oauth-2-0.html) for more information about OAuth 2.0.<br/><br/>**ALL AUDIT LOG OPERATIONS ARE SCOPED TO A TEAM.**\",\"title\":\"Celonis Audit Log API\",\"version\":\"1.0.0\"},\"servers\":[{\"description\":\"Generated server url\",\"url\":\"http://localhost:8888/log\"}],\"security\":[{\"Authorization\":[]}],\"tags\":[{\"description\":\"For Querying Audit Logs in a team\",\"name\":\"Audit Log API\"}],\"paths\":{\"/api/external/audit\":{\"get\":{\"description\":\"Audit Logs can be filtered specifying a date interval.<br> Maximum number of Audit Logs that will be received by page is 200. <br> If there would be more Audit Logs on the specified date interval total number of pages will be returned for further querying.<br> 'USE AUDIT LOGS API' permission should be enabled\",\"operationId\":\"findAllAuditLogs\",\"parameters\":[{\"description\":\"Page number to be retrieved, starts with 0\",\"example\":0,\"in\":\"query\",\"name\":\"pageNumber\",\"required\":false,\"schema\":{\"type\":\"integer\",\"format\":\"int32\",\"default\":0,\"minimum\":0}},{\"description\":\"Limit of results per page\",\"example\":200,\"in\":\"query\",\"name\":\"pageSize\",\"required\":false,\"schema\":{\"type\":\"integer\",\"format\":\"int32\",\"default\":200,\"maximum\":200,\"minimum\":1}},{\"description\":\"Date Time ISO 8601 yyyy-MM-ddTHH:mm:ss\",\"example\":\"2021-01-01T09:00:00\",\"in\":\"query\",\"name\":\"from\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}},{\"description\":\"Date Time ISO 8601 yyyy-MM-ddTHH:mm:ss\",\"example\":\"2021-01-31T09:00:00\",\"in\":\"query\",\"name\":\"to\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PageTransportAuditLogExternalTransport\"}}},\"description\":\"OK\"},\"204\":{\"description\":\"No Content\"},\"400\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}},\"description\":\"Bad Request\"},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}},\"description\":\"Internal Server Error\"}},\"security\":[{\"Authorization\":[]}],\"summary\":\"List Audit Logs\",\"tags\":[\"Audit Log API\"]}}},\"components\":{\"schemas\":{\"AuditLogExternalTransport\":{\"type\":\"object\",\"properties\":{\"diffPayload\":{\"$ref\":\"#/components/schemas/DiffPayloadExternalTransport\"},\"event\":{\"type\":\"string\"},\"ipAddress\":{\"type\":\"string\"},\"message\":{\"type\":\"object\"},\"port\":{\"type\":\"string\"},\"timestamp\":{\"type\":\"string\",\"format\":\"date-time\"},\"userId\":{\"type\":\"string\"},\"userRole\":{\"type\":\"string\"}}},\"DiffPayloadExternalTransport\":{\"type\":\"object\",\"properties\":{\"newValue\":{\"type\":\"string\"},\"oldValue\":{\"type\":\"string\"}}},\"ExceptionReference\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\"},\"reference\":{\"type\":\"string\"},\"shortMessage\":{\"type\":\"string\"}}},\"FrontendHandledBackendError\":{\"type\":\"object\",\"properties\":{\"errorInformation\":{\"type\":\"object\"},\"frontendErrorKey\":{\"type\":\"string\"}}},\"PageTransportAuditLogExternalTransport\":{\"type\":\"object\",\"properties\":{\"content\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/AuditLogExternalTransport\"}},\"pageNumber\":{\"type\":\"integer\",\"format\":\"int32\"},\"pageSize\":{\"type\":\"integer\",\"format\":\"int32\"},\"totalCount\":{\"type\":\"integer\",\"format\":\"int64\"}}}},\"securitySchemes\":{\"Authorization\":{\"description\":\"Please, prefix the Token with \\\"AppKey \\\" or \\\"Bearer \\\" (word and space) to indicate the Authorization type\",\"in\":\"header\",\"name\":\"Authorization\",\"type\":\"apiKey\"}}}}},\"options\":{\"hideTryItPanel\":false,\"pagination\":\"item\",\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","redocHasSecurityDefinitions":false,"redocInfoPageLink":"","redocItemId":"overview","redocHasInfoPage":true,"settings":{},"requestLogin":false,"lastModified":"2026-01-05T21:57:24.000Z"},"seo":{"title":"Overview"}}},"pageContext":{"id":"b7583657-4ac7-5276-975b-8bc40e5c2599overview__redocly content/celonis-apis/audit-log-api/openapi/openapi-external/overview/","seo":{"title":"Overview","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"celonis-apis/audit-log-api/openapi/openapi-external.yaml#overview","pageBaseUrl":"/celonis-apis/audit-log-api/openapi/openapi-external","type":"redoc-info","toc":{"enable":true,"maxDepth":4,"headings":null},"data":{},"catalogInfo":null,"link":"/celonis-apis/audit-log-api/openapi/openapi-external/overview/","sidebarName":"celonis","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":[{"definitionId":"autogenerated_celonis-apis/audit-log-api/openapi/openapi-external.yaml","id":null,"title":null,"isDefault":true,"apiId":null}],"apiVersionId":null,"isDefaultApiVersion":true}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}