This section contains reference information on the REST APIs that are made available by .

Access to API reference docs

NOTE: URLs to API reference documentation are case-sensitive.

To access the reference documentation for each available API endpoint and method, select Help menu > API Documentation in the .

Enable Access

Access tokens required

If the API documentation is not available, a workspace administrator must enable the use of API access tokens.

API tokens enable users and processes to access the REST APIs available through the .

Tip: Individual users do not need personal API access tokens to use the API documentation. The feature must be enabled.

For more information, see Workspace Settings Page.

Enable access through the menu

To enable the Help menu option and access to the API documentation, the following parameter must be enabled.


  1. Login to the application as an administrator.
  2. Locate the following parameter and set it to true:

    "webapp.apiDoc.enabled": true,
  3. Save your changes and restart the platform.

API Endpoint Documentation

You can access API reference documentation through the . In the left navigation bar, select Help menu > API Documentation.