{{ 'API documentation' | translate }}

Welcome to the Cumulocity API documentation

Your comprehensive, version-aligned API reference for the Cumulocity IoT Platform

This application provides complete API documentation extracted directly from your installed Cumulocity core and microservices. Every endpoint, parameter, and response is automatically synchronized with your current platform version, ensuring accuracy and reliability.

How to use this app

This application provides comprehensive API documentation using the industry-standard Swagger/OpenAPI format. Each API endpoint is fully documented with:

  • Complete specifications:

    Parameters, request/response schemas, and examples

  • Try it out:

    Execute API calls directly from your browser using your current session

  • Code samples:

    See real request and response examples for each endpoint

Available APIs

@for (app of documentedApps$ | async; track app.id) { {{ app.appLabel }} @let noDescription = 'No description provided' | translate; {{ (app.description | translate) || noDescription }} }