GitHub Get Started

API Reference

REST API documentation for GOTRS developers.

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

Authentication

  • POST /auth/login - Authenticate user
  • POST /auth/logout - Invalidate session
  • POST /auth/refresh - Refresh JWT token

Tickets

  • GET /tickets - List tickets
  • POST /tickets - Create ticket
  • GET /tickets/{id} - Get ticket details
  • PUT /tickets/{id} - Update ticket
  • DELETE /tickets/{id} - Delete ticket

Users

  • GET /users - List users
  • POST /users - Create user
  • GET /users/{id} - Get user details
  • PUT /users/{id} - Update user
  • DELETE /users/{id} - Delete user

Attachments

  • POST /tickets/{id}/attachments - Upload attachment
  • GET /attachments/{id} - Download attachment
  • DELETE /attachments/{id} - Delete attachment

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.