API Documentation Site (Document Generator)

This page provides you with information about the access and use of the API documentation site or Documentation Generator.

Access

To access your API documentation site, navigate to your URL followed by /platform/api/v1/static/swagger-ui/

Use of the API documentation site

• acts as a comprehensive guide, listing all APIs available and providing you with information about the APIs (kept up to date with every release)
• assists you on utilizing the APIs by introducing you to the required fields, field types, and error codes