HomeTechnical SupportGetting started with our REST API
Technical Support1 min readUpdated June 2, 2026

Getting started with our REST API

Back to Technical Support

API Authentication & Quickstart

Welcome to our REST API documentation! Our API is organized around REST. All requests are authenticated via a bearer token.

1. Obtaining a Token

Go to **Admin Panel** > **Settings** > **API Keys** and click **Generate Token**. Keep this token secure, as it has write access to your helpdesk properties.

2. Send Your First Request

bash

curl -X GET "https://api.helpdesk.local/v1/tickets" \

-H "Authorization: Bearer YOUR_API_TOKEN" \

-H "Accept: application/json"

3. Error Responses

  • `401 Unauthorized`: The token is invalid or has expired.
  • `403 Forbidden`: Access denied for this resource.
  • `404 Not Found`: Resource does not exist.
  • Still need assistance?

    If this guide didn’t fully resolve your issue, our support team is ready to help. Submit a detailed ticket and we’ll respond promptly.