How to Use Swagger UI to Test the BoldDesk REST API

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.

What Swagger UI Provides

Swagger UI enables the following actions:

• Visualize REST API endpoints
• Understand available operations and required parameters
• Execute (“Try It Out”) requests directly from the browser
• Test API responses in real time
• Validate API integrations before implementation

This makes Swagger UI a powerful tool for API development, testing, and debugging.

Follow the following steps to test an API using Swagger

1. First, generate an API Key. Explore How to Generate a BoldDesk API Key.

2. To access Swagger UI, open this URL https://xyz.bolddesk.com/api/help/index.html
   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 the 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 BoldDesk API Docs.
   

Troubleshooting Tips

• If authorization fails, ensure your API key has not expired or been revoked.
• If endpoints are missing, verify that your BoldDesk site URL is correct.
• If requests return 401 Unauthorized, reauthorize Swagger UI with a new key.

FAQs

1. What is Swagger UI?
   Swagger UI is a browser-based tool that displays API documentation and allows you to execute REST API operations interactively.

2. Do I need an API key to use Swagger UI?
   Yes. An API key is required for authenticated BoldDesk API endpoints.

3. Where do I obtain the API key?
   Generate it through the BoldDesk admin portal by following the official documentation, How to Generate a BoldDesk API Key?

4. Can I test all BoldDesk API endpoints in Swagger UI?
   Yes, all available endpoints that your role has permissions for will be visible and testable.

5. Is the Swagger URL the same for every BoldDesk site?
   Yes, except for the domain prefix. Use: https://.bolddesk.com/api/help/index.html