Our Swagger API documentation is interactive, making it easy to understand how to interact with the APIs. In order to use our APIs, the user must obtain the appropriate API Keys.
To Access Custom API Keys
1. Go to the User Management dropdown.
2. Select API Keys.
To Access API Documentation
1. Once the custom API keys have been obtained, go to the User Management dropdown.
2. Select API Documentation from the dropdown menu.
Note: The url will be the base url being used then "/api/v4", as shown below:
All calls will require the accesstoken. This is generated as a response to the /generateToken call. The /generateToken API call requires keys from the API Keys page above.
Responses may be set in the request as 'json' or 'xml' on all calls to more robustly integration with external solutions. Only Team Admins have keys allowing them to access management functions.