BoldDesk REST API Overview for Developers
BoldDesk REST API enables third-party applications to interact with BoldDesk programmatically over HTTP. BoldDesk REST API supports standard CRUD operations (read, create, update, delete) and typically uses JSON for request and response payloads.
BoldDesk REST API can be used to manage common BoldDesk objects, including:
- Tickets
- Contacts
- Contact groups
- Groups
- Fields
- Other supported resources exposed in the Developer API reference.
Supported operations
BoldDesk REST API endpoints generally support the following operation types (availability depends on the specific resource and endpoint):
- Read: Retrieve a single object or a collection of objects.
- Create: Create a new object.
- Update: Edit an existing object.
- Delete: Remove an existing object.
For the complete list of available resources, endpoints, and request/response schemas, use the Developer API reference.
Request and data format
- BoldDesk REST API requests and responses are typically formatted as JSON.
- Payload structure, required properties, and supported query parameters vary by endpoint and are defined in the Developer API documentation.
Authentication and API security
BoldDesk REST API access is secured. Authentication requirements, supported authentication mechanisms, and enforcement details are documented in BoldDesk API Authentication Guide: Secure Access Made Simple.
API key generation
If the BoldDesk REST API requires an API key for authentication, follow the API key generation instructions. Learn more on Generate and Manage API Keys in BoldDesk.
Developer API reference (endpoint catalog)
Use the BoldDesk Developer API portal to find:
- Base URL details
- Resource and endpoint list
- Required headers and authentication usage
- Request/response examples
- Error responses per endpoint
Frequently Asked Questions (FAQs)
1) What is the BoldDesk REST API?
The BoldDesk REST API enables third-party applications to interact with BoldDesk programmatically over HTTP. It supports common REST patterns and typically uses JSON for both request and response payloads.
2) What can I manage using the BoldDesk REST API?
You can use the API to manage many common BoldDesk objects and resources, including:
- Tickets
- Contacts
- Contact groups
- Groups
- Fields
- Other supported resources available in the Developer API reference.
3) What operations does the BoldDesk REST API support?
BoldDesk REST API endpoints generally support standard CRUD operations (depending on the resource/endpoint):
- Read: Retrieve a single object or a collection of objects
- Create: Create a new object
- Update: Modify an existing object
- Delete: Remove an existing object
For the exact operations available per endpoint, refer to the Developer API reference.
4) How do I authenticate when calling the BoldDesk REST API?
BoldDesk REST API access is secured, and authentication requirements depend on the method supported and enforced for your account/environment. Use these resources:
- Authentication overview and enforcement details: BoldDesk API Authentication Guide: Secure Access Made Simple.
- API key generation and management (if an API key is required): Generate and Manage API Keys in BoldDesk.
