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.
API updates are attributed to the API key owner
Any ticket creation or ticket update performed through the BoldDesk API is associated with the user account that generated the API key. This is expected system behavior.
How the API key name is used
- The API key label (or any brand-related name you assign to the key) is used only for internal identification.
- The API key label is not displayed in tickets, conversations, or update history.
What you will see on tickets
- Tickets and updates created via the API will display the name of the user who created the API key.
- BoldDesk does not display a brand-level identity for API activity by default.
Use a generic or brand-friendly display name (recommended setup)
If you want API-created tickets and updates to show a generic or brand name:
- Create a dedicated agent account (for example, “API Bot” or “Brand Support”).
- Grant the required API access/permissions to this account.
- Generate a new API key while signed in as this dedicated account.
- Use this new key for all API requests.
Tickets and updates created using that key will display the dedicated agent account name as the creator/updater.
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.
Q4: Who will appear as the creator/updater on tickets created or updated via the API?
Tickets and updates created via the API show the name of the user account that generated the API key.
Q5: Will the API key label or brand name appear on the ticket?
No. The API key label is for internal identification only and is not displayed in tickets, conversations, or history.
