GOTRS API Reference

RESTful API documentation for integrating with GOTRS.

Note: The complete OpenAPI specification is maintained in the gotrs-ce repository.

Overview

GOTRS provides two API layers:

1. v1 API (/api/v1/*) - RESTful JSON API for programmatic access
2. Internal API (/api/*) - Used by the HTMX web interface

Base URL

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

Authentication

# Login and get JWT token
curl -X POST https://your-instance.com/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username":"admin","password":"your-password"}'

# Use token in subsequent requests
curl -X GET https://your-instance.com/api/v1/tickets \
  -H "Authorization: Bearer $JWT_TOKEN"

Response Format

{
  "success": true,
  "data": {...},
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 100,
    "total_pages": 5
  }
}

Error Format

{
  "success": false,
  "error": "Error message description"
}

Core Endpoints

Authentication

Tickets

Articles

Bulk Operations

Queues

Users

Search

Dashboard

Admin Endpoints

Requires admin role.

LDAP Integration

Admin only.

Health Checks

Status Codes

Rate Limiting

OpenAPI Specification

The complete OpenAPI 3.0 specification is available in the gotrs-ce repository:

• openapi.yaml
• openapi.json

You can use these with tools like Swagger UI, Postman, or code generators.

SDKs

Coming soon:

• TypeScript SDK
• Python SDK
• Go SDK

For the complete API specification, see the gotrs-ce repository.