Skip to main content

Support Service API

Auto-generated from NestJS controller decorators. Last synced: 2026-03-15

Base path: /api
Endpoints: 13


Support Analytics

Get support ticket analytics and metrics

GET/support/analyticsBearer token

Comments

Add a comment to a ticket

POST/tickets/:ticketId/commentsBearer token
ticketIdstringRequired

path parameter

Request Body: AddCommentDto

bodystringRequired

internalboolean


List comments for a ticket

GET/tickets/:ticketId/commentsBearer token
ticketIdstringRequired

path parameter

includeInternalstring

query parameter


Health

Liveness probe

GET/health

Readiness probe

GET/ready

Tickets

Create a new support ticket

POST/ticketsBearer token

Request Body: CreateTicketDto

subjectstringRequired

descriptionstringRequired

priorityTicketPriority

categoryTicketCategory

relatedResourcesorderId?: string; serviceInstanceId?: string; invoiceId?: string;


List tickets (filtered, paginated, tenant-isolated)

GET/ticketsBearer token
queryTicketQueryDtoRequired

query parameter


Get ticket statistics (counts by status and priority)

GET/tickets/statsBearer token

Get ticket by ID with comments

GET/tickets/:idBearer token
idstringRequired

path parameter


Update ticket status, priority, or category

PATCH/tickets/:idBearer token
idstringRequired

path parameter

Request Body: UpdateTicketDto

statusTicketStatus

priorityTicketPriority

categoryTicketCategory


Assign ticket to an agent (admin/support_agent only)

PATCH/tickets/:id/assignBearer token
idstringRequired

path parameter

Request Body: AssignTicketDto

assigneeIdstringRequired


Close a ticket

PATCH/tickets/:id/closeBearer token
idstringRequired

path parameter


Reopen a closed or resolved ticket

PATCH/tickets/:id/reopenBearer token
idstringRequired

path parameter