Skip to main content

Helpdesk API Documentation

Audience​

Developers, QA engineers, support engineers, security engineers, solution architects and implementation partners.

Overview​

This section documents the verified HTTP surface owned by Helpdesk Service and its Helpdesk-specific employee gateway boundary. It does not document deployment addresses, generated OpenAPI output or database details.

Summary​

The Helpdesk API is Transitional. The authoritative inventory contains 39 operations: 30 canonical Helpdesk endpoints, five compatibility endpoints, two shared operational endpoints and two employee gateway endpoints. Canonical and compatibility routes coexist; the gateway can select legacy or extracted ownership for the compatibility prefix.

No explicit authentication or authorization requirement is registered by the reviewed Helpdesk Service. Tenant filtering exists, but read behavior does not consistently require a tenant and the outbox diagnostic query is not tenant-filtered.

Documentation map​

Use the endpoint catalog as the sole authoritative inventory. Supporting pages cover architecture, authentication, authorization, tenant context, request lifecycle, tickets, categories, priorities, assignment, comments, attachments, dashboards, compatibility, gateway boundaries, DTOs, validation, responses, errors, health, versioning, testing, limitations and the source map.

Maturity​

Canonical ticket operations are Foundation/Partial. Compatibility and gateway ownership are Transitional. Requester isolation, authorization, contract alignment and dedicated API tests are not implemented in the reviewed source.

Requires confirmation​

Production routing, trusted identity propagation, authorization enforcement, OpenAPI exposure, versioning policy and compatibility retirement require confirmation.

Source References​

  • microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs
  • microservices/src/helpdesk-service/Program.cs
  • microservices/src/gateway-api/Program.cs
  • microservices/src/gateway-api/EssEndpoints.cs
  • microservices/src/shared-kernel/Extensions/EndpointRouteBuilderExtensions.cs

See Also​

Keywords​

Helpdesk API, ticket endpoint, compatibility API, employee gateway.

Revision Information​

  • Status: Draft
  • Last reviewed: 2026-07-20
  • Next review: 2026-10-20