Skip to main content
Back to Admin Console API Scopes define the level of access and control that an app has over various features and services within the platform. By creating apps and assigning appropriate scopes, developers and administrators can securely manage how different components of the platform are accessed and interacted with via public APIs. This modular approach ensures fine-grained access control, enabling you to expose only the required functionalities to each app or integration.

Getting Started

To begin using API scopes:
  1. Create an App
    • Click the + New API Scope button to create a new app.
    • Select the +Create App option from the App drop-down.
    • Enter an App Name. Once submitted, a Client ID and Client Secret are generated automatically.
    • These credentials are used to authenticate API requests made by the app.
  2. Assign API Scopes
    • Assign scopes based on the features your app needs to access.
    • Scopes are permission categories that unlock specific platform capabilities.
API Scopes

Supported API Scopes

The following API scopes are available for this feature. Once an app is configured with the necessary scopes, it can be used either from within the App Builder Platform or externally through the platform’s public APIs. For the complete list of supported APIs, refer to the corresponding public API (see here for list).