Quick SummarySwagger documentation provides a standardized way to describe and visualize APIs, showing what requests they accept and what responses they return - like a detailed menu that shows all available options. It allows developers to understand, test, and integrate with APIs without needing to read through pages of technical documentation.
Accessing the Documentation
Documentation is generated for each API group. At the top of the API group page, just click

Locating the Swagger documentation
Using the Documentation
1
Review the API information shown.
Each API will show you the method, the API name, and the description on the left side.
On the right, you’ll see a 🔓 icon if that API requires authentication.
Click the


V
to interact with your API of choice.2
Sending Authenticated Requests
If any of the API(s) you want to interact with require authentication, click
at the top of the page to supply an authentication token.

3
Click 'Try it out' to send a request to that API.

4
Fill in any request body values or parameters necessary.

5
Click 'Execute' to send the test request.


Additional Features
Defining Sample Inputs and Responses
NoteWe’re currently rolling out this feature to all users as part of our next release. If you don’t have it yet, you will soon! Hang tight.
1
In the 'response' section of the Run panel, click Set As Example

2
Review the sample input and response, and make any necessary adjustments
Make sure these do not include any sensitive information.

3
Click Save and you will see these defined in your Swagger documentation.


Copy / Copy as cURL
Throughout the documentation, you’ll see
JSON OpenAPI Spec
