Article Content

Overview

Swagger provides access to all the Core API endpoints, organized by service. Swagger is available through the Swagger Docs tile under the Tools on the Admin Overview screen. 

Admin: Help Screen

User Account Requirements

The user must have Administrator permissions to access the Admin Overview screen.

Tips

• Clicking a resource will reveal the available endpoints. Clicking an endpoint with a GET method will display an example response body and any parameters.
• Clicking the Example Value box will copy its contents into the body field where you can configure it as needed.
• Some endpoints include an Example Value, which displays a sample response and/or body parameters. Clicking Example Value in the Parameters section will copy its contents into the body field.
• Clicking Model beside Example Value will display the data types and whether or not they're optional. Hovering your cursor over these data types will display additional requirements, if any, such as minimum or maximum number of characters.

API Endpoint