How to Test the BoldDesk Rest API Using Swagger

Swagger UI allows your development team to visualize and interact with the BoldDesk Rest API’s resources without having any of the implementation logic in place.

Follow the following steps to test an API using Swagger

1. First Generate an API Key by referring to this doc https://support.bolddesk.com/kb/article/84/how-to-generate-a-bolddesk-api-key

2. To access Swagger UI. Open this URL /api/help/index.html
   For example, if your site URL is https://xyz.bolddesk.com For example, if your site URL is https://xyz.bolddesk.com then open this URL https://xyz.bolddesk.com/api/help/index.html

3. Next Click on Authorize button and fill in the API Key

After successful authorization, you will get this message. Then close the dialog

4. Now you can try out any APIs. For detailed API documentation, which API and what input is accepted please refer to this doc.