BoldDesk API Authentication Guide: Secure Access Made Simple
BoldDesk API uses API key-based authentication to secure requests. Every API call must include a valid API key in the request header.
How to Authenticate API Requests
To make an API request:
curl -X GET "https://{your-domain}/api/v1/tickets" \ -H "x-api-key: {API Key}"
Key Points
- The
x-api-keyheader is required for all API requests. - The API key authenticates and authorizes your request.
- If the API key is valid and has sufficient permissions, the requested resource will be returned.
Generating an API Key
To obtain an API key, follow the steps in this guide: How to Generate a BoldDesk API Key.
Currently, BoldDesk API access requires authentication through a licensed agent account. At this time, it’s not possible to set up a system or integration-only account for API usage without assigning a license.
Frequently Asked Questions (FAQs)
Q1: Can I use OAuth or other authentication methods?
No, BoldDesk API currently supports only API key-based authentication.
Q2: What happens if my API key is invalid or expired?
The request will fail with an authentication error. Generate a new key if needed.
Q3: Can I create an API key without assigning a license?
No, a licensed agent account is mandatory for API access.
