HelpdeskHero provides a public REST API for managing your helpdesk content programmatically. Use it to integrate with your existing tools, automate content creation, or build custom workflows.
Getting Your API Key
- Go to Settings in your dashboard
- Find the API Key section
- Click Generate API Key
- Copy and store the key securely
Your API key grants full access to your helpdesk content. Keep it secret and never expose it in client-side code or public repositories.
Authentication
Include your API key in the X-API-Key header with every request:
curl https://helpdeskhero.app/api/v1/categories \
-H "X-API-Key: your-api-key-here"
Base URL
https://helpdeskhero.app/api/v1/
If you are using a custom domain, you can also use:
https://your-domain.com/api/v1/
Categories
List All Categories
GET /api/v1/categories
Create a Category
POST /api/v1/categories
Content-Type: application/json
{
"name": "Getting Started",
"description": "Introductory guides",
"icon": "rocket"
}
Update a Category
PATCH /api/v1/categories/:id
Content-Type: application/json
{
"name": "Updated Name",
"description": "Updated description"
}
Delete a Category
DELETE /api/v1/categories/:id
Articles
List All Articles
GET /api/v1/articles
Optional query parameter: ?categoryId=uuid to filter by category.
Create an Article
POST /api/v1/articles
Content-Type: application/json
{
"title": "My New Article",
"content": "## Introduction\n\nArticle content in Markdown...",
"excerpt": "A short summary of the article",
"categoryId": "category-uuid-here",
"published": true
}
Required fields: title and content. All other fields are optional.
Update an Article
PATCH /api/v1/articles/:id
Content-Type: application/json
{
"title": "Updated Title",
"content": "Updated content...",
"published": true
}
Delete an Article
DELETE /api/v1/articles/:id
Response Format
All responses follow the same structure:
Success:
{
"data": { ... }
}
Error:
{
"error": "Error message here"
}
Rate Limits
The API does not currently enforce rate limits, but please be reasonable with your request volume.
Article content should be written in Markdown format. The public help center automatically renders Markdown into formatted HTML with syntax highlighting, callout blocks, and more.
Example: Creating a Complete Article
curl -X POST https://helpdeskhero.app/api/v1/articles \
-H "X-API-Key: your-api-key-here" \
-H "Content-Type: application/json" \
-d '{
"title": "How to Reset Your Password",
"content": "## Steps\n\n1. Click **Forgot Password** on the login page\n2. Enter your email address\n3. Check your inbox for a reset link\n\n> [!info]\n> The reset link expires after 24 hours.",
"excerpt": "Step-by-step guide to resetting your account password.",
"categoryId": "your-category-id",
"published": true
}'