BoldDesk publishes a Swagger UI page that links to the OpenAPI definition JSON file for your BoldDesk site.

Prerequisites

• You must know your BoldDesk site URL (example: https://xyz.bolddesk.com).
• You must be able to access your site’s API documentation endpoint.

Steps to Locate the Open API Definition for BoldDesk Rest APIs

1. In a browser, open:

   https://<your-site>.bolddesk.com/api/help/index.html

   Example:

   https://xyz.bolddesk.com/api/help/index.html

2. Confirm the Swagger API docs page loads.

3. On the Swagger page, locate the OpenAPI JSON link:

   /api/help/swagger/v1/swagger.json

4. Select the link to open the JSON definition in the browser.

   

5. Copy the URL and download it with a tool such as curl:

   curl -o swagger.json https://<your-site>.bolddesk.com/api/help/swagger/v1/swagger.json

Frequently Asked Questions

1) What is the Swagger UI page used for in BoldDesk?

BoldDesk publishes a Swagger UI page that provides access to your site’s API documentation and includes a link to the OpenAPI definition JSON file.

2) What do I need before I can access the OpenAPI definition?

You need:

• Your BoldDesk site URL (for example, https://xyz.bolddesk.com)
• Access to your site’s API documentation endpoint

3) Where do I open the Swagger UI for my BoldDesk site?

Open this URL in your browser:

https://<your-site>.bolddesk.com/api/help/index.html

Example:

https://xyz.bolddesk.com/api/help/index.html

4) How do I find the OpenAPI JSON link in Swagger UI?

After the Swagger API docs page loads, locate the OpenAPI JSON link:

/api/help/swagger/v1/swagger.json

Select the link to open the JSON definition in your browser.

5) How can I download the OpenAPI JSON file?

Copy the OpenAPI JSON URL and download it using a tool such as curl:

curl -o swagger.json https://<your-site>.bolddesk.com/api/help/swagger/v1/swagger.json