Helmdesk
DocsBlogPricingFeaturesSupport
Sign inGet started

REST API

The Helmdesk REST API uses standard HTTP methods and returns JSON. All endpoints require Bearer token authentication.

Base URL

https://helmdesk.dev/api/v1

Authentication

Every request must include your project API key as a Bearer token in the Authorization header. Keys begin with sk_live_ and are created from Dashboard → Project → API Keys.

curl https://helmdesk.dev/api/v1/tickets \
  -H "Authorization: Bearer sk_live_abc123..."

Requests without a valid key return 401 Unauthorized. See Authentication for SDK usage and key management.

Endpoints

MethodPathDescription
POST/ticketsCreate a ticket
GET/ticketsList tickets
GET/tickets/:idGet ticket detail
PATCH/tickets/:idUpdate a ticket
POST/tickets/:id/messagesAdd a message
POST/tickets/:id/tagsAdd a tag to a ticket
DELETE/tickets/:id/tagsRemove a tag from a ticket
POST/emails/sendSend an email
POST/emails/batchSend up to 100 emails in one request (Pro+)
POST/emails/previewPreview template
GET/email-templates/:key/schemaTemplate schema
POST/email-templates/importImport template file
POST/account/email-templates/importImport shared template
GET/articles/searchSearch articles
POST/articlesCreate a knowledge-base article
POST/logsIngest up to 100 log events
GET/logsList log events
GET/log-issuesList grouped error issues

OpenAPI specification

The full OpenAPI 3.1 spec is available at:

https://helmdesk.dev/openapi.json

Use it to generate clients in any language, import into Postman, or integrate with API documentation tools.

For detailed request/response examples, see the resource-specific docs: Tickets, Emails, Articles.