GOTRS API Reference

RESTful API documentation for integrating with GOTRS.

Overview

The GOTRS API provides programmatic access to all ticketing system functionality.

Base URL

https://your-gotrs-instance.com/api/v1

Authentication

Authorization: Bearer YOUR_JWT_TOKEN

Response Format

{
  "success": true,
  "data": {...},
  "error": null
}

Endpoints

Current Coverage (October 2025)

• POST /auth/login – Session-based agent authentication with HX-Redirect support

• POST /auth/logout – Invalidate the active session

• GET /tickets – Filterable ticket list (defaults to not_closed, supports search/pagination)

• POST /tickets – Create ticket (agent workflow)

• GET /tickets/{id} – Ticket detail view

• PUT /tickets/{id} – Update ticket metadata (title, queue, state, priority)

• DELETE /tickets/{id} – Soft-delete ticket (admin only)

• POST /tickets/{id}/status – Update ticket state, including close/reopen flows

• POST /tickets/{id}/priority – Change priority

• POST /tickets/{id}/queue – Move ticket to another queue

• POST /tickets/{id}/assign – Reassign ticket to another agent

• POST /tickets/{id}/reply – Add agent/customer-visible articles with internal/external flags and time accounting

Planned Additions

• POST /auth/refresh – Refresh JWT token (in progress)
• POST /tickets/{id}/articles – Add agent/customer replies
• POST /tickets/{id}/attachments – Upload attachment
• GET /attachments/{id} – Download attachment
• DELETE /attachments/{id} – Delete attachment
• GET /users and related CRUD – Admin directory management

Status Codes

• 200 - Success
• 201 - Created
• 400 - Bad Request
• 401 - Unauthorized
• 403 - Forbidden
• 404 - Not Found
• 500 - Internal Server Error

Rate Limiting

• 1000 requests per hour per API key
• Rate limit headers included in responses
• 429 status code when limit exceeded

SDKs and Libraries

Coming soon:

• JavaScript/TypeScript SDK
• Python SDK
• Go SDK
• curl examples

API documentation is being developed alongside the core system. Check back for updates.