Extends osTicket's REST API with powerful endpoints for advanced ticket management. Enables ticket creation with Markdown formatting, department routing, subticket support, and comprehensive ticket management (update, retrieve, search, delete, statistics).
- Extended Ticket Creation with Markdown formatting, department routing, subticket support
- Full Ticket Management (update, retrieve, search, delete); a status change can carry
feedback: true|falsefor the Feedback plugin (0.2+) - Subticket API for parent-child relationships (requires Subticket Manager Plugin)
- Ticket Statistics (global, by department, by staff)
- Task API: read, search, create, update (edit, link to a ticket, assign, transfer, due date, close/reopen, notes) and delete osTicket tasks, run as a configurable agent
- Knowledge Base API: list, create and change FAQ categories; search, read, create and change FAQ articles (internal/public/featured), with friendly
/kb/<slug>URLs read from the root.htaccess. No delete - Granular API Key Permissions per endpoint
- Name-Based Filters (human-readable names instead of IDs)
- No Core Modifications (Signal-based architecture, update-safe)
- TDD-Tested with 168 tests
- osTicket 1.18.x
- PHP 8.1+
- Optional: Markdown Support Plugin for Markdown rendering
- Download
api-endpoints-vX.Y.Z.zipfrom the latest release and unzip it; it contains theapi-endpointsfolder - Upload the
api-endpointsfolder to/include/plugins/on your osTicket server - Enable in Admin Panel > Manage > Plugins
- English: https://faq.markus-michalski.net/en/osticket/api-endpoints
- Deutsch: https://faq.markus-michalski.net/de/osticket/api-endpoints
- API Reference: https://faq.markus-michalski.net/en/osticket/api-endpoints/api-documentation
Thanks to everyone who has contributed fixes and features:
- @studio-prisma — ticket-creation authentication fix, subticket plugin resolution fix, bootstrap exception handling fix, ticket stats cast fix
- @ianice-lng — email filter for the ticket search endpoint
See CONTRIBUTING.md if you'd like to contribute too.
Released under the GNU General Public License v2, compatible with osTicket core. See LICENSE.
See CHANGELOG.md for version history.