8. REST API Specifications

This API reference was updated from the supplied OpenAPI 3.0.4 specifications for the Ticketing API and User API. It is intended for implementation, integration, testing, and handover teams.

---

8.1 API Sources

API	OpenAPI Title	Version	Path Count	Primary Base Path
Ticketing API	Ticketing Api	v1	129	/ticket-api
User API	User API	v1	94	/user-api

Base paths are deployment conventions used by the documentation. Confirm the final host and reverse-proxy path during installation.

---

8.2 Authentication and Common Headers

Most protected endpoints should be called with a valid bearer token returned by the user/authentication service. Public endpoints, if any, must be confirmed during environment hardening.

Header	Required	Description
Authorization: Bearer <token>	Yes, for protected endpoints	JWT access token for the signed-in user.
Content-Type: application/json	Yes, for JSON body requests	Indicates a JSON request payload.
Accept: application/json	Recommended	Requests JSON response data.
Content-Type: multipart/form-data	When uploading files	Used by attachment or file upload endpoints.

---

8.3 Ticketing API Catalog

8.3.1 Ai

Method	Endpoint	Operation	Parameters	Request Body	Responses
POST	/ticket-api/correct-text	POST /ticket-api/correct-text	-	application/json: TextCorrectionRequestDto text/json: TextCorrectionRequestDto application/*+json: TextCorrectionRequestDto	200 OK

8.3.2 Application

Method	Endpoint	Operation	Parameters	Request Body	Responses
POST	/ticket-api/application	POST /ticket-api/application	-	application/json: CreateApplication text/json: CreateApplication application/*+json: CreateApplication	200 OK
DELETE	/ticket-api/application/{key}	DELETE /ticket-api/application/{key}	key (path, required, string)	-	200 OK
GET	/ticket-api/application/{key}	GET /ticket-api/application/{key}	key (path, required, string)	-	200 OK
PUT	/ticket-api/application/{key}	PUT /ticket-api/application/{key}	key (path, required, string)	application/json: UpdateApplication text/json: UpdateApplication application/*+json: UpdateApplication	200 OK
GET	/ticket-api/applications/{organizationId}	GET /ticket-api/applications/{organizationId}	organizationId (path, required, string) page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string)	-	200 OK

8.3.3 Branch

Method	Endpoint	Operation	Parameters	Request Body	Responses
POST	/ticket-api/branch	POST /ticket-api/branch	-	application/json: CreateBranch text/json: CreateBranch application/*+json: CreateBranch	200 OK
DELETE	/ticket-api/branch/{key}	DELETE /ticket-api/branch/{key}	key (path, required, integer)	-	200 OK
GET	/ticket-api/branch/{key}	GET /ticket-api/branch/{key}	key (path, required, integer)	-	200 OK
PUT	/ticket-api/branch/{key}	PUT /ticket-api/branch/{key}	key (path, required, integer)	application/json: UpdateBranch text/json: UpdateBranch application/*+json: UpdateBranch	200 OK
GET	/ticket-api/branches/{organizationId}	GET /ticket-api/branches/{organizationId}	organizationId (path, required, string) page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string)	-	200 OK
PUT	/ticket-api/bulk-branches	PUT /ticket-api/bulk-branches	-	application/json: BulkBranchStatusDto text/json: BulkBranchStatusDto application/*+json: BulkBranchStatusDto	200 OK

8.3.4 BranchPermission

Method	Endpoint	Operation	Parameters	Request Body	Responses
POST	/ticket-api/branch-permission	POST /ticket-api/branch-permission	-	application/json: CreateBranchPermission text/json: CreateBranchPermission application/*+json: CreateBranchPermission	200 OK
DELETE	/ticket-api/branch-permission/{key}	DELETE /ticket-api/branch-permission/{key}	key (path, required, integer)	-	200 OK
GET	/ticket-api/branch-permission/{key}	GET /ticket-api/branch-permission/{key}	key (path, required, integer)	-	200 OK
PUT	/ticket-api/branch-permission/{key}	PUT /ticket-api/branch-permission/{key}	key (path, required, integer)	application/json: UpdateBranchPermission text/json: UpdateBranchPermission application/*+json: UpdateBranchPermission	200 OK
GET	/ticket-api/branch-permissions/{organizationId}/{branchId}	GET /ticket-api/branch-permissions/{organizationId}/{branchId}	organizationId (path, required, string) branchId (path, required, integer) page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string)	-	200 OK

8.3.5 Category

Method	Endpoint	Operation	Parameters	Request Body	Responses
GET	/ticket-api/categories-list/{organizationId}	GET /ticket-api/categories-list/{organizationId}	organizationId (path, required, string)	-	200 OK
GET	/ticket-api/categories/{organizationId}	GET /ticket-api/categories/{organizationId}	organizationId (path, required, string) page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string)	-	200 OK
POST	/ticket-api/category	POST /ticket-api/category	-	application/json: CreateCategory text/json: CreateCategory application/*+json: CreateCategory	200 OK
GET	/ticket-api/category-by-parent/{parentId}	GET /ticket-api/category-by-parent/{parentId}	organizationId (query, string) parentId (path, required, integer) page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string)	-	200 OK
DELETE	/ticket-api/category/{key}	DELETE /ticket-api/category/{key}	key (path, required, integer)	-	200 OK
GET	/ticket-api/category/{key}	GET /ticket-api/category/{key}	key (path, required, integer)	-	200 OK
PUT	/ticket-api/category/{key}	PUT /ticket-api/category/{key}	key (path, required, integer)	application/json: UpdateCategory text/json: UpdateCategory application/*+json: UpdateCategory	200 OK
GET	/ticket-api/parent-categories/{organizationId}	GET /ticket-api/parent-categories/{organizationId}	organizationId (path, required, string) search (query, string)	-	200 OK

8.3.6 IdentifiedCategory

Method	Endpoint	Operation	Parameters	Request Body	Responses
GET	/ticket-api/identify-categories/{categoryId}/{organizationId}	GET /ticket-api/identify-categories/{categoryId}/{organizationId}	categoryId (path, required, integer) organizationId (path, required, string)	-	200 OK
GET	/ticket-api/identify-categories/{organizationId}	GET /ticket-api/identify-categories/{organizationId}	organizationId (path, required, string) page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string)	-	200 OK
POST	/ticket-api/identify-category	POST /ticket-api/identify-category	-	application/json: CreateIdentifiedCategory text/json: CreateIdentifiedCategory application/*+json: CreateIdentifiedCategory	200 OK
DELETE	/ticket-api/identify-category/{key}	DELETE /ticket-api/identify-category/{key}	key (path, required, integer)	-	200 OK
GET	/ticket-api/identify-category/{key}	GET /ticket-api/identify-category/{key}	key (path, required, integer)	-	200 OK
PUT	/ticket-api/identify-category/{key}	PUT /ticket-api/identify-category/{key}	key (path, required, integer)	application/json: UpdateIdentifiedCategory text/json: UpdateIdentifiedCategory application/*+json: UpdateIdentifiedCategory	200 OK

8.3.7 Incident

Method	Endpoint	Operation	Parameters	Request Body	Responses
GET	/ticket-api/admin-incidents/{organizationId}	GET /ticket-api/admin-incidents/{organizationId}	organizationId (path, required, string)	-	200 OK
GET	/ticket-api/agent-reply-suggestion/{incidentId}/{organizationId}	GET /ticket-api/agent-reply-suggestion/{incidentId}/{organizationId}	incidentId (path, required, string) organizationId (path, required, string)	-	200 OK
POST	/ticket-api/confirm-similar-resolve-ticket/{suggestionId}/{organizationId}	POST /ticket-api/confirm-similar-resolve-ticket/{suggestionId}/{organizationId}	suggestionId (path, required, string) organizationId (path, required, string)	-	200 OK
POST	/ticket-api/confirm-similar-resolve/{resolvedIncidentId}/{organizationId}	POST /ticket-api/confirm-similar-resolve/{resolvedIncidentId}/{organizationId}	resolvedIncidentId (path, required, string) organizationId (path, required, string)	-	200 OK
GET	/ticket-api/filter-incidents/{organizationId}/{startDate}/{endDate}	GET /ticket-api/filter-incidents/{organizationId}/{startDate}/{endDate}	organizationId (path, required, string) startDate (path, required, string) endDate (path, required, string)	-	200 OK
POST	/ticket-api/incident	POST /ticket-api/incident	-	multipart/form-data: object	200 OK
PUT	/ticket-api/incident-close/{organizationId}	PUT /ticket-api/incident-close/{organizationId}	organizationId (path, required, string) userId (query, string)	application/json: ClosedIncident text/json: ClosedIncident application/*+json: ClosedIncident	200 OK
GET	/ticket-api/incident-details/{key}/{organizationId}	GET /ticket-api/incident-details/{key}/{organizationId}	key (path, required, string) organizationId (path, required, string)	-	200 OK
GET	/ticket-api/incident-list/{organizationId}	GET /ticket-api/incident-list/{organizationId}	organizationId (path, required, string) search (query, string) page (query, integer) pageSize (query, integer)	-	200 OK
GET	/ticket-api/incident-portal/{key}/{organizationId}	GET /ticket-api/incident-portal/{key}/{organizationId}	key (path, required, string) organizationId (path, required, string) page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string)	-	200 OK
GET	/ticket-api/incident-report/{organizationId}	GET /ticket-api/incident-report/{organizationId}	organizationId (path, required, string) startDate (query, string) endDate (query, string) status (query) severity (query) facilityName (query, string) categoryId (query, integer) facilityId (query, string) regionId (query, string) assignedUserId (query, string) page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string) parentCategoryId (query, integer)	-	200 OK
GET	/ticket-api/incident-reports/download-csv/{organizationId}	GET /ticket-api/incident-reports/download-csv/{organizationId}	organizationId (path, required, string) startDate (query, string) endDate (query, string) status (query) severity (query) facilityName (query, string) search (query, string) categoryId (query, integer) facilityId (query, string) regionId (query, string) assignedUserId (query, string) parentCategoryId (query, integer)	-	200 OK
GET	/ticket-api/incident-status/{email}/{organizationId}	GET /ticket-api/incident-status/{email}/{organizationId}	email (path, required, string) organizationId (path, required, string) slNumber (query, string)	-	200 OK
PUT	/ticket-api/incident-status/{key}	PUT /ticket-api/incident-status/{key}	key (path, required, string) organizationId (query, string)	application/json: IncidentStatusDto text/json: IncidentStatusDto application/*+json: IncidentStatusDto	200 OK
DELETE	/ticket-api/incident/{key}	DELETE /ticket-api/incident/{key}	key (path, required, string) organizationId (query, string)	-	200 OK
PUT	/ticket-api/incident/{key}	PUT /ticket-api/incident/{key}	key (path, required, string) organizationId (query, string)	multipart/form-data: object	200 OK
GET	/ticket-api/incident/{key}/{organizationId}	GET /ticket-api/incident/{key}/{organizationId}	key (path, required, string) organizationId (path, required, string)	-	200 OK
GET	/ticket-api/incident/assigned-by-region/{expertId}/{organizationId}	GET /ticket-api/incident/assigned-by-region/{expertId}/{organizationId}	expertId (path, required, string) organizationId (path, required, string) page (query, integer) pageSize (query, integer) search (query, string) status (query) ticketPriority (query) isAssigned (query, boolean) startDate (query, string) endDate (query, string) regionId (query, string)	-	200 OK
GET	/ticket-api/incident/categorywise-count/{organizationId}	GET /ticket-api/incident/categorywise-count/{organizationId}	organizationId (path, required, string) startDate (query, string) endDate (query, string)	-	200 OK
GET	/ticket-api/incident/companyId/{companyId}/{organizationId}	GET /ticket-api/incident/companyId/{companyId}/{organizationId}	companyId (path, required, string) organizationId (path, required, string) contactId (query, string) page (query, integer) pageSize (query, integer) search (query, string) status (query) ticketPriority (query) startDate (query, string) endDate (query, string)	-	200 OK
GET	/ticket-api/incident/contactNumber/{contactNumber}/{organizationId}	GET /ticket-api/incident/contactNumber/{contactNumber}/{organizationId}	contactNumber (path, required, string) organizationId (path, required, string)	-	200 OK
GET	/ticket-api/incident/details-count/{organizationId}	GET /ticket-api/incident/details-count/{organizationId}	organizationId (path, required, string) startDate (query, string) endDate (query, string)	-	200 OK
GET	/ticket-api/incident/facility-wise-count/{organizationId}	GET /ticket-api/incident/facility-wise-count/{organizationId}	organizationId (path, required, string) startDate (query, string) endDate (query, string)	-	200 OK
GET	/ticket-api/incident/networkDeviceId/{networkDeviceId}	GET /ticket-api/incident/networkDeviceId/{networkDeviceId}	networkDeviceId (path, required, string)	-	200 OK
GET	/ticket-api/incident/team-wise-count/{organizationId}	GET /ticket-api/incident/team-wise-count/{organizationId}	organizationId (path, required, string) startDate (query, string) endDate (query, string)	-	200 OK
GET	/ticket-api/incidents/{organizationId}	GET /ticket-api/incidents/{organizationId}	organizationId (path, required, string) page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string) incidentStatus (query) startDate (query, string) endDate (query, string) isAssigned (query, boolean) companyName (query, string) regionId (query, string) expertUserId (query, string) applicationId (query, string) categoryId (query, integer) parentCategoryId (query, integer)	-	200 OK
GET	/ticket-api/last-incident/organizationId/{organizationId}	GET /ticket-api/last-incident/organizationId/{organizationId}	organizationId (path, required, string)	-	200 OK
GET	/ticket-api/similar-resolved-tickets/{incidentId}/{organizationId}	GET /ticket-api/similar-resolved-tickets/{incidentId}/{organizationId}	incidentId (path, required, string) organizationId (path, required, string)	-	200 OK
GET	/ticket-api/ticket-solution-suggestions/{organizationId}	GET /ticket-api/ticket-solution-suggestions/{organizationId}	organizationId (path, required, string) title (query, string) description (query, string)	-	200 OK
PUT	/ticket-api/transfer-incident/{key}	PUT /ticket-api/transfer-incident/{key}	key (path, required, string)	application/json: TeamTransferDto text/json: TeamTransferDto application/*+json: TeamTransferDto	200 OK

8.3.8 IncidentAssigned

Method	Endpoint	Operation	Parameters	Request Body	Responses
POST	/ticket-api/incident-assigned	POST /ticket-api/incident-assigned	-	application/json: CreateIdentifiedAssignedIncident text/json: CreateIdentifiedAssignedIncident application/*+json: CreateIdentifiedAssignedIncident	200 OK
GET	/ticket-api/incident-assigned-by-user/{userId}/{organizationId}	GET /ticket-api/incident-assigned-by-user/{userId}/{organizationId}	userId (path, required, string) organizationId (path, required, string) page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string)	-	200 OK
GET	/ticket-api/incident-assigned-thread/{userId}/{incidentId}	GET /ticket-api/incident-assigned-thread/{userId}/{incidentId}	userId (path, required, string) incidentId (path, required, string) page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string)	-	200 OK
DELETE	/ticket-api/incident-assigned/{key}	DELETE /ticket-api/incident-assigned/{key}	key (path, required, string)	-	200 OK
PUT	/ticket-api/incident-assigned/{key}	PUT /ticket-api/incident-assigned/{key}	key (path, required, string)	application/json: UpdateIdentifiedAssignedIncident text/json: UpdateIdentifiedAssignedIncident application/*+json: UpdateIdentifiedAssignedIncident	200 OK
GET	/ticket-api/incident-assigned/{key}/{organizationId}	GET /ticket-api/incident-assigned/{key}/{organizationId}	key (path, required, string) organizationId (path, required, string)	-	200 ObjectIEnumerableApiResponse OK
GET	/ticket-api/incident-assigned/member/{memberId}/{organizationId}	GET /ticket-api/incident-assigned/member/{memberId}/{organizationId}	memberId (path, required, string) organizationId (path, required, string) page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string) incidentStatus (query) startDate (query, string) endDate (query, string) isAssigned (query, boolean) companyName (query, string)	-	200 OK
GET	/ticket-api/incident-assigned/member/download-csv/{organizationId}	GET /ticket-api/incident-assigned/member/download-csv/{organizationId}	organizationId (path, required, string) startDate (query, string) endDate (query, string) categoryId (query, integer) brandName (query, string) incidentStatus (query)	-	200 OK
GET	/ticket-api/incident-assigns/{incidentId}/{organizationId}	GET /ticket-api/incident-assigns/{incidentId}/{organizationId}	incidentId (path, required, string) organizationId (path, required, string) page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string)	-	200 OK

8.3.9 IncidentAttachment

Method	Endpoint	Operation	Parameters	Request Body	Responses
DELETE	/ticket-api/delete-incident-attachment	DELETE /ticket-api/delete-incident-attachment	-	application/json: DeleteAttachmentDto text/json: DeleteAttachmentDto application/*+json: DeleteAttachmentDto	200 OK
GET	/ticket-api/incident-attachment/{incidentId}	GET /ticket-api/incident-attachment/{incidentId}	incidentId (path, required, string)	-	200 OK

8.3.10 IncidentHistory

Method	Endpoint	Operation	Parameters	Request Body	Responses
GET	/ticket-api/incident-history/{incidentId}/{organizationId}	GET /ticket-api/incident-history/{incidentId}/{organizationId}	incidentId (path, required, string) organizationId (path, required, string) page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string) actionType (query)	-	200 OK

8.3.11 Message

Method	Endpoint	Operation	Parameters	Request Body	Responses
POST	/ticket-api/message	POST /ticket-api/message	-	multipart/form-data: object	200 MessageDtoApiResponse OK
DELETE	/ticket-api/message/{key}	DELETE /ticket-api/message/{key}	key (path, required, string)	-	200 BooleanApiResponse OK
GET	/ticket-api/message/{key}	GET /ticket-api/message/{key}	key (path, required, string)	-	200 MessageApiResponse OK
PUT	/ticket-api/message/{key}	PUT /ticket-api/message/{key}	key (path, required, string)	multipart/form-data: object	200 MessageDtoApiResponse OK
GET	/ticket-api/messages-external/{incidentId}	GET /ticket-api/messages-external/{incidentId}	incidentId (path, required, string) page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string)	-	200 OK
GET	/ticket-api/messages/{incidentId}	GET /ticket-api/messages/{incidentId}	incidentId (path, required, string) page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string)	-	200 OK
GET	/ticket-api/messages/sl/{sl}/{organizationId}	GET /ticket-api/messages/sl/{sl}/{organizationId}	sl (path, required, string) organizationId (path, required, string) page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string)	-	200 OK

8.3.12 PriorityConfiguration

Method	Endpoint	Operation	Parameters	Request Body	Responses
POST	/ticket-api/priority-configuration	POST /ticket-api/priority-configuration	organizationId (query, string)	application/json: array<CreatePriorityConfigurationDto> text/json: array<CreatePriorityConfigurationDto> application/*+json: array<CreatePriorityConfigurationDto>	200 OK
GET	/ticket-api/priority-configurations/{organizationId}	GET /ticket-api/priority-configurations/{organizationId}	organizationId (path, required, string)	-	200 OK

8.3.13 Report

Method	Endpoint	Operation	Parameters	Request Body	Responses
GET	/ticket-api/download-executive-facility-ticket-summary	GET /ticket-api/download-executive-facility-ticket-summary	organizationId (query, string) userId (query, string) regionId (query, string) startDate (query, string) endDate (query, string) dashboardTimeFilter (query)	-	200 OK
GET	/ticket-api/download-executive-technician-ticket-summary	GET /ticket-api/download-executive-technician-ticket-summary	organizationId (query, string) regionId (query, string) userId (query, string) startDate (query, string) endDate (query, string) dashboardTimeFilter (query)	-	200 OK
GET	/ticket-api/executive-application-ticket-summary	GET /ticket-api/executive-application-ticket-summary	organizationId (query, string) regionId (query, string) startDate (query, string) endDate (query, string) dashboardTimeFilter (query)	-	200 OK
GET	/ticket-api/executive-facility-ticket-summary	GET /ticket-api/executive-facility-ticket-summary	organizationId (query, string) regionId (query, string) startDate (query, string) endDate (query, string) dashboardTimeFilter (query)	-	200 OK
GET	/ticket-api/executive-facility-ticket-with-pagination-summary	GET /ticket-api/executive-facility-ticket-with-pagination-summary	organizationId (query, string) regionId (query, string) facilityId (query, string) startDate (query, string) endDate (query, string) dashboardTimeFilter (query) pageNumber (query, integer) pageSize (query, integer)	-	200 OK
GET	/ticket-api/executive-recurring-issue-summary	GET /ticket-api/executive-recurring-issue-summary	organizationId (query, string) regionId (query, string) startDate (query, string) endDate (query, string) dashboardTimeFilter (query)	-	200 OK
GET	/ticket-api/executive-regional-ticket-summary	GET /ticket-api/executive-regional-ticket-summary	organizationId (query, string) regionId (query, string) startDate (query, string) endDate (query, string) dashboardTimeFilter (query)	-	200 OK
GET	/ticket-api/executive-technician-ticket-summary	GET /ticket-api/executive-technician-ticket-summary	organizationId (query, string) regionId (query, string) startDate (query, string) endDate (query, string) dashboardTimeFilter (query)	-	200 OK
GET	/ticket-api/executive-technician-ticket-with-pagination-summary	GET /ticket-api/executive-technician-ticket-with-pagination-summary	organizationId (query, string) regionId (query, string) expertId (query, string) startDate (query, string) endDate (query, string) dashboardTimeFilter (query) pageNumber (query, integer) pageSize (query, integer)	-	200 OK
GET	/ticket-api/executive-ticket-priority-summary	GET /ticket-api/executive-ticket-priority-summary	organizationId (query, string) regionId (query, string) startDate (query, string) endDate (query, string) dashboardTimeFilter (query)	-	200 OK
GET	/ticket-api/executive-ticket-summary	GET /ticket-api/executive-ticket-summary	organizationId (query, string) regionId (query, string) startDate (query, string) endDate (query, string) dashboardTimeFilter (query)	-	200 OK
GET	/ticket-api/monthly-incident-count-wise	GET /ticket-api/monthly-incident-count-wise	organizationId (query, string)	-	200 OK
GET	/ticket-api/monthwise-count-wise	GET /ticket-api/monthwise-count-wise	organizationId (query, string)	-	200 OK
GET	/ticket-api/regional-average-response-summary	GET /ticket-api/regional-average-response-summary	organizationId (query, string) regionId (query, string) startDate (query, string) endDate (query, string) dashboardTimeFilter (query)	-	200 OK
GET	/ticket-api/regional-facility-rank-summary	GET /ticket-api/regional-facility-rank-summary	organizationId (query, string) regionId (query, string) startDate (query, string) endDate (query, string) dashboardTimeFilter (query)	-	200 OK
GET	/ticket-api/regional-open-ticket-summary	GET /ticket-api/regional-open-ticket-summary	organizationId (query, string) regionId (query, string) startDate (query, string) endDate (query, string) dashboardTimeFilter (query) page (query, integer) pageSize (query, integer)	-	200 OK
GET	/ticket-api/regional-ticket-result-list	GET /ticket-api/regional-ticket-result-list	organizationId (query, string) regionId (query, string) startDate (query, string) endDate (query, string) dashboardTimeFilter (query) page (query, integer) pageSize (query, integer) categoryId (query, integer) applicationId (query, string)	-	200 OK
GET	/ticket-api/root-cause-frequent-issue-summary	GET /ticket-api/root-cause-frequent-issue-summary	organizationId (query, string) regionId (query, string) startDate (query, string) endDate (query, string) dashboardTimeFilter (query)	-	200 OK
GET	/ticket-api/sla-achievement-count	GET /ticket-api/sla-achievement-count	organizationId (query, string) regionId (query, string) priority (query) startDate (query, string) endDate (query, string) dashboardTimeFilter (query)	-	200 OK
GET	/ticket-api/technician-assigned-ticket	GET /ticket-api/technician-assigned-ticket	organizationId (query, string) expertId (query, string) startDate (query, string) endDate (query, string) dashboardTimeFilter (query)	-	200 OK
GET	/ticket-api/technician-closed-ticket	GET /ticket-api/technician-closed-ticket	organizationId (query, string) expertId (query, string) startDate (query, string) endDate (query, string) dashboardTimeFilter (query)	-	200 OK
GET	/ticket-api/technician-due-ticket	GET /ticket-api/technician-due-ticket	organizationId (query, string) expertId (query, string) startDate (query, string) endDate (query, string) dashboardTimeFilter (query)	-	200 OK
GET	/ticket-api/technician-high-priority-ticket	GET /ticket-api/technician-high-priority-ticket	organizationId (query, string) expertId (query, string) startDate (query, string) endDate (query, string) dashboardTimeFilter (query)	-	200 OK
GET	/ticket-api/technician-pending-ticket	GET /ticket-api/technician-pending-ticket	organizationId (query, string) expertId (query, string) startDate (query, string) endDate (query, string) dashboardTimeFilter (query)	-	200 OK
GET	/ticket-api/technician-performance-stat-ticket	GET /ticket-api/technician-performance-stat-ticket	organizationId (query, string) expertId (query, string) startDate (query, string) endDate (query, string) dashboardTimeFilter (query)	-	200 OK
GET	/ticket-api/technician-productivity	GET /ticket-api/technician-productivity	organizationId (query, string) startDate (query, string) endDate (query, string) dashboardTimeFilter (query)	-	200 OK
GET	/ticket-api/technician-sla-ticket	GET /ticket-api/technician-sla-ticket	organizationId (query, string) expertId (query, string) startDate (query, string) endDate (query, string) dashboardTimeFilter (query)	-	200 OK

8.3.14 ReportFile

Method	Endpoint	Operation	Parameters	Request Body	Responses
GET	/ticket-api/annual-incident-report	GET /ticket-api/annual-incident-report	organizationId (query, string) userId (query, string)	-	200 OK
GET	/ticket-api/annual-incident-report-list	GET /ticket-api/annual-incident-report-list	organizationId (query, string) pageNumber (query, integer) pageSize (query, integer)	-	200 OK
GET	/ticket-api/average-resolution-time-report	GET /ticket-api/average-resolution-time-report	organizationId (query, string) fromDate (query, string) toDate (query, string) pageNumber (query, integer) pageSize (query, integer)	-	200 OK
GET	/ticket-api/average-resolution-time-report-download	GET /ticket-api/average-resolution-time-report-download	organizationId (query, string) userId (query, string) fromDate (query, string) toDate (query, string)	-	200 OK
GET	/ticket-api/daily-incident-report	GET /ticket-api/daily-incident-report	organizationId (query, string) userId (query, string)	-	200 OK
GET	/ticket-api/daily-incident-report-list	GET /ticket-api/daily-incident-report-list	organizationId (query, string) pageNumber (query, integer) pageSize (query, integer)	-	200 OK
GET	/ticket-api/escalated-tickets-report	GET /ticket-api/escalated-tickets-report	organizationId (query, string) fromDate (query, string) toDate (query, string) pageNumber (query, integer) pageSize (query, integer)	-	200 OK
GET	/ticket-api/escalated-tickets-report-download	GET /ticket-api/escalated-tickets-report-download	organizationId (query, string) userId (query, string) fromDate (query, string) toDate (query, string)	-	200 OK
GET	/ticket-api/first-time-fix-rate-report	GET /ticket-api/first-time-fix-rate-report	organizationId (query, string) fromDate (query, string) toDate (query, string) pageNumber (query, integer) pageSize (query, integer)	-	200 OK
GET	/ticket-api/first-time-fix-rate-report-download	GET /ticket-api/first-time-fix-rate-report-download	organizationId (query, string) userId (query, string) fromDate (query, string) toDate (query, string)	-	200 OK
GET	/ticket-api/monthly-incident-report	GET /ticket-api/monthly-incident-report	organizationId (query, string) userId (query, string)	-	200 OK
GET	/ticket-api/monthly-incident-report-list	GET /ticket-api/monthly-incident-report-list	organizationId (query, string) pageNumber (query, integer) pageSize (query, integer)	-	200 OK
GET	/ticket-api/overall-sla-report	GET /ticket-api/overall-sla-report	organizationId (query, string) fromDate (query, string) toDate (query, string) pageNumber (query, integer) pageSize (query, integer)	-	200 OK
GET	/ticket-api/overall-sla-report-download	GET /ticket-api/overall-sla-report-download	organizationId (query, string) userId (query, string) fromDate (query, string) toDate (query, string)	-	200 OK
GET	/ticket-api/sla-breached-report	GET /ticket-api/sla-breached-report	organizationId (query, string) fromDate (query, string) toDate (query, string) pageNumber (query, integer) pageSize (query, integer)	-	200 OK
GET	/ticket-api/sla-breached-report-download	GET /ticket-api/sla-breached-report-download	organizationId (query, string) userId (query, string) fromDate (query, string) toDate (query, string)	-	200 OK
GET	/ticket-api/sla-met-report	GET /ticket-api/sla-met-report	organizationId (query, string) fromDate (query, string) toDate (query, string) pageNumber (query, integer) pageSize (query, integer)	-	200 OK
GET	/ticket-api/sla-met-report-download	GET /ticket-api/sla-met-report-download	organizationId (query, string) userId (query, string) fromDate (query, string) toDate (query, string)	-	200 OK
GET	/ticket-api/tickets-by-facility-report	GET /ticket-api/tickets-by-facility-report	organizationId (query, string) fromDate (query, string) toDate (query, string) pageNumber (query, integer) pageSize (query, integer)	-	200 OK
GET	/ticket-api/tickets-by-facility-report-download	GET /ticket-api/tickets-by-facility-report-download	organizationId (query, string) userId (query, string) fromDate (query, string) toDate (query, string)	-	200 OK
GET	/ticket-api/tickets-by-region-report	GET /ticket-api/tickets-by-region-report	organizationId (query, string) fromDate (query, string) toDate (query, string) pageNumber (query, integer) pageSize (query, integer)	-	200 OK
GET	/ticket-api/tickets-by-region-report-download	GET /ticket-api/tickets-by-region-report-download	organizationId (query, string) userId (query, string) fromDate (query, string) toDate (query, string)	-	200 OK
GET	/ticket-api/tickets-handled-per-technician-report	GET /ticket-api/tickets-handled-per-technician-report	organizationId (query, string) fromDate (query, string) toDate (query, string) pageNumber (query, integer) pageSize (query, integer)	-	200 OK
GET	/ticket-api/tickets-handled-per-technician-report-download	GET /ticket-api/tickets-handled-per-technician-report-download	organizationId (query, string) userId (query, string) fromDate (query, string) toDate (query, string)	-	200 OK
GET	/ticket-api/weekly-incident-report	GET /ticket-api/weekly-incident-report	organizationId (query, string) userId (query, string)	-	200 OK
GET	/ticket-api/weekly-incident-report-list	GET /ticket-api/weekly-incident-report-list	organizationId (query, string) pageNumber (query, integer) pageSize (query, integer)	-	200 OK

8.3.15 Team

Method	Endpoint	Operation	Parameters	Request Body	Responses
POST	/ticket-api/team	POST /ticket-api/team	-	application/json: CreateTeam text/json: CreateTeam application/*+json: CreateTeam	200 OK
DELETE	/ticket-api/team/{key}	DELETE /ticket-api/team/{key}	key (path, required, integer)	-	200 OK
GET	/ticket-api/team/{key}	GET /ticket-api/team/{key}	key (path, required, integer)	-	200 OK
PUT	/ticket-api/team/{key}	PUT /ticket-api/team/{key}	key (path, required, integer)	application/json: UpdateTeam text/json: UpdateTeam application/*+json: UpdateTeam	200 OK
GET	/ticket-api/teams/{organizationId}	GET /ticket-api/teams/{organizationId}	organizationId (path, required, string) page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string)	-	200 OK
GET	/ticket-api/user-teams/{organizationId}/{userId}	GET /ticket-api/user-teams/{organizationId}/{userId}	organizationId (path, required, string) userId (path, required, string)	-	200 OK

8.3.16 TeamMember

Method	Endpoint	Operation	Parameters	Request Body	Responses
DELETE	/ticket-api/bulk-team-member	DELETE /ticket-api/bulk-team-member	-	application/json: RemoveTeamMemberDto text/json: RemoveTeamMemberDto application/*+json: RemoveTeamMemberDto	200 OK
POST	/ticket-api/team-member	POST /ticket-api/team-member	-	application/json: CreateTeamMember text/json: CreateTeamMember application/*+json: CreateTeamMember	200 OK
DELETE	/ticket-api/team-member/{key}	DELETE /ticket-api/team-member/{key}	key (path, required, integer)	-	200 OK
PUT	/ticket-api/team-member/{key}	PUT /ticket-api/team-member/{key}	key (path, required, integer)	application/json: UpdateTeamMember text/json: UpdateTeamMember application/*+json: UpdateTeamMember	200 OK
GET	/ticket-api/team-members/{organizationId}/{teamId}	GET /ticket-api/team-members/{organizationId}/{teamId}	organizationId (path, required, string) teamId (path, required, integer) page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string)	-	200 OK

---

8.4 User API Catalog

8.4.1 AssignedDepartment

Method	Endpoint	Operation	Parameters	Request Body	Responses
POST	/user-api/assigned-department	POST /user-api/assigned-department	-	application/json: CreateAssignUserDepartmentDto text/json: CreateAssignUserDepartmentDto application/*+json: CreateAssignUserDepartmentDto	200 OK
GET	/user-api/assigned-user-department/{departmentId}	GET /user-api/assigned-user-department/{departmentId}	departmentId (path, required, string) page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string)	-	200 OK
GET	/user-api/assigned-user-department/{departmentId}/{organizationId}	GET /user-api/assigned-user-department/{departmentId}/{organizationId}	departmentId (path, required, string) organizationId (path, required, string)	-	200 OK
DELETE	/user-api/delete-assigned-department/{key}	DELETE /user-api/delete-assigned-department/{key}	key (path, required, string)	-	200 OK
POST	/user-api/multiple-assigned-department	POST /user-api/multiple-assigned-department	-	application/json: AssignDepartmentDto text/json: AssignDepartmentDto application/*+json: AssignDepartmentDto	200 OK
GET	/user-api/multiple-assigned-department/{organizationId}	GET /user-api/multiple-assigned-department/{organizationId}	organizationId (path, required, string) page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string)	-	200 OK

8.4.2 AssignedOrganizationService

Method	Endpoint	Operation	Parameters	Request Body	Responses
POST	/user-api/assigned-organization-service	POST /user-api/assigned-organization-service	-	application/json: CreateAssignedOrganizationService text/json: CreateAssignedOrganizationService application/*+json: CreateAssignedOrganizationService	200 OK
DELETE	/user-api/delete-assigned-organization-service	DELETE /user-api/delete-assigned-organization-service	-	application/json: DeleteAssignedOrganizationService text/json: DeleteAssignedOrganizationService application/*+json: DeleteAssignedOrganizationService	200 OK
DELETE	/user-api/delete-multiple-assigned-organization-service	DELETE /user-api/delete-multiple-assigned-organization-service	-	application/json: array<DeleteAssignedOrganizationService> text/json: array<DeleteAssignedOrganizationService> application/*+json: array<DeleteAssignedOrganizationService>	200 OK
POST	/user-api/multiple-assigned-organization-service	POST /user-api/multiple-assigned-organization-service	-	application/json: array<CreateAssignedOrganizationService> text/json: array<CreateAssignedOrganizationService> application/*+json: array<CreateAssignedOrganizationService>	200 OK
GET	/user-api/multiple-assigned-organization-service/{organizationId}	GET /user-api/multiple-assigned-organization-service/{organizationId}	organizationId (path, required, string)	-	200 OK

8.4.3 AutomationRule

Method	Endpoint	Operation	Parameters	Request Body	Responses
POST	/user-api/automation-rule	POST /user-api/automation-rule	-	application/json: CreateAutomationRuleDto text/json: CreateAutomationRuleDto application/*+json: CreateAutomationRuleDto	200 OK
GET	/user-api/automation-rules/{organizationId}	GET /user-api/automation-rules/{organizationId}	organizationId (path, required, string)	-	200 CreateAutomationRuleDtoApiResponse OK
GET	/user-api/automation-rules/by-time/{organizationId}	GET /user-api/automation-rules/by-time/{organizationId}	organizationId (path, required, string)	-	200 OK
GET	/user-api/exist-automation-rule/{organizationId}/{serviceType}/{eventType}	GET /user-api/exist-automation-rule/{organizationId}/{serviceType}/{eventType}	organizationId (path, required, string) serviceType (path, required) eventType (path, required)	-	200 GetExistingAutomationDtoApiResponse OK

8.4.4 Company

Method	Endpoint	Operation	Parameters	Request Body	Responses
GET	/user-api/companies/{organizationId}	GET /user-api/companies/{organizationId}	organizationId (path, required, string) regionId (query, string) page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string)	-	200 OK
POST	/user-api/company	POST /user-api/company	-	application/json: CreateCompany text/json: CreateCompany application/*+json: CreateCompany	200 OK
GET	/user-api/company-by-region/{regionId}	GET /user-api/company-by-region/{regionId}	regionId (path, required, string) organizationId (query, string) search (query, string)	-	200 OK
DELETE	/user-api/company/{key}	DELETE /user-api/company/{key}	key (path, required, string) organizationId (query, string)	-	200 OK
PUT	/user-api/company/{key}	PUT /user-api/company/{key}	key (path, required, string)	application/json: UpdateCompany text/json: UpdateCompany application/*+json: UpdateCompany	200 OK
GET	/user-api/company/{key}/{organizationId}	GET /user-api/company/{key}/{organizationId}	key (path, required, string) organizationId (path, required, string)	-	200 OK

8.4.5 Contact

Method	Endpoint	Operation	Parameters	Request Body	Responses
GET	/user-api/check-contact/{contactId}/{userAccountId}	GET /user-api/check-contact/{contactId}/{userAccountId}	userAccountId (path, required, string) contactId (path, required, string)	-	200 boolean OK
POST	/user-api/contact	POST /user-api/contact	-	application/json: CreateContact text/json: CreateContact application/*+json: CreateContact	200 OK
GET	/user-api/contact-company/{cellphone}/{companyId}	GET /user-api/contact-company/{cellphone}/{companyId}	cellphone (path, required, string) companyId (path, required, string)	-	200 OK
GET	/user-api/contact-details-phone/{search}/{organizationId}	GET /user-api/contact-details-phone/{search}/{organizationId}	search (path, required, string) organizationId (path, required, string) regionId (query, string)	-	200 OK
GET	/user-api/contact-details/{contactId}/{organizationId}	GET /user-api/contact-details/{contactId}/{organizationId}	contactId (path, required, string) organizationId (path, required, string)	-	200 OK
GET	/user-api/contact-email/{email}/{organizationId}	GET /user-api/contact-email/{email}/{organizationId}	email (path, required, string) organizationId (path, required, string)	-	200 OK
POST	/user-api/contact-login	POST /user-api/contact-login	-	application/json: ContactLoginDto text/json: ContactLoginDto application/*+json: ContactLoginDto	200 OK
GET	/user-api/contact-organization/{organizationId}	GET /user-api/contact-organization/{organizationId}	organizationId (path, required, string) page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string)	-	200 OK
GET	/user-api/contact-phone/{phone}/{organizationId}	GET /user-api/contact-phone/{phone}/{organizationId}	phone (path, required, string) organizationId (path, required, string)	-	200 OK
GET	/user-api/contact-search-organization/{organizationId}	GET /user-api/contact-search-organization/{organizationId}	search (query, string) organizationId (path, required, string)	-	200 OK
POST	/user-api/contact-validation	POST /user-api/contact-validation	organizationId (query, string)	application/json: ContactDto text/json: ContactDto application/*+json: ContactDto	200 OK
DELETE	/user-api/contact/{key}	DELETE /user-api/contact/{key}	key (path, required, string)	-	200 OK
GET	/user-api/contact/{key}	GET /user-api/contact/{key}	key (path, required, string)	-	200 OK
PUT	/user-api/contact/{key}	PUT /user-api/contact/{key}	key (path, required, string)	application/json: UpdateContact text/json: UpdateContact application/*+json: UpdateContact	200 OK
GET	/user-api/contacts-by-region/{organizationId}	GET /user-api/contacts-by-region/{organizationId}	organizationId (path, required, string) regionId (query, string) search (query, string)	-	200 OK
GET	/user-api/contacts/{companyId}	GET /user-api/contacts/{companyId}	companyId (path, required, string) page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string)	-	200 OK
GET	/user-api/search-contact/{organizationId}/{search}	GET /user-api/search-contact/{organizationId}/{search}	organizationId (path, required, string) search (path, required, string)	-	200 OK

8.4.6 Department

Method	Endpoint	Operation	Parameters	Request Body	Responses
POST	/user-api/department	POST /user-api/department	-	application/json: CreateDepartmentDto text/json: CreateDepartmentDto application/*+json: CreateDepartmentDto	200 OK
DELETE	/user-api/department/{key}	DELETE /user-api/department/{key}	key (path, required, string)	-	200 OK
PUT	/user-api/department/{key}	PUT /user-api/department/{key}	key (path, required, string)	application/json: UpdateDepartmentDto text/json: UpdateDepartmentDto application/*+json: UpdateDepartmentDto	200 OK
GET	/user-api/department/{key}/{organizationId}	GET /user-api/department/{key}/{organizationId}	key (path, required, string) organizationId (path, required, string)	-	200 OK
GET	/user-api/departments/{organizationId}	GET /user-api/departments/{organizationId}	organizationId (path, required, string) page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string)	-	200 OK

8.4.7 Organization

Method	Endpoint	Operation	Parameters	Request Body	Responses
GET	/user-api/check-organization-suffix-duplicate/{organizationSuffix}	GET /user-api/check-organization-suffix-duplicate/{organizationSuffix}	organizationSuffix (path, required, string) organizationId (query, string)	-	200 OK
PUT	/user-api/link-whatsApp/{organizationId}	PUT /user-api/link-whatsApp/{organizationId}	organizationId (path, required, string)	application/json: LinkWhatsAppDto text/json: LinkWhatsAppDto application/*+json: LinkWhatsAppDto	200 OK
POST	/user-api/organization	POST /user-api/organization	-	application/json: CreateOrganization text/json: CreateOrganization application/*+json: CreateOrganization	200 OK
PUT	/user-api/organization-by-organization-admin/{key}	PUT /user-api/organization-by-organization-admin/{key}	key (path, required, string)	application/json: UpdateOrganizationByOrganizationAdmin text/json: UpdateOrganizationByOrganizationAdmin application/*+json: UpdateOrganizationByOrganizationAdmin	200 OK
GET	/user-api/organization-by-user/{userId}	GET /user-api/organization-by-user/{userId}	userId (path, required, string) page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string)	-	200 OK
GET	/user-api/organization-by-userId/{userId}	GET /user-api/organization-by-userId/{userId}	userId (path, required, string)	-	200 OK
GET	/user-api/organization-suffix/{suffix}	GET /user-api/organization-suffix/{suffix}	suffix (path, required, string)	-	200 OK
DELETE	/user-api/organization/{key}	DELETE /user-api/organization/{key}	key (path, required, string)	-	200 OK
GET	/user-api/organization/{key}	GET /user-api/organization/{key}	key (path, required, string)	-	200 OK
PUT	/user-api/organization/{key}	PUT /user-api/organization/{key}	key (path, required, string)	application/json: UpdateOrganization text/json: UpdateOrganization application/*+json: UpdateOrganization	200 OK
GET	/user-api/organizations	GET /user-api/organizations	page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string)	-	200 OK
PUT	/user-api/user-active-in-active-from-organization	PUT /user-api/user-active-in-active-from-organization	-	application/json: InActiveUserFromOrganizationDto text/json: InActiveUserFromOrganizationDto application/*+json: InActiveUserFromOrganizationDto	200 OK
GET	/user-api/whats-app-phone-id/{phoneId}	GET /user-api/whats-app-phone-id/{phoneId}	phoneId (path, required, string)	-	200 OK

8.4.8 Package

Method	Endpoint	Operation	Parameters	Request Body	Responses
POST	/user-api/multiple-packages	POST /user-api/multiple-packages	-	application/json: array<CreatePackage> text/json: array<CreatePackage> application/*+json: array<CreatePackage>	200 OK
POST	/user-api/package	POST /user-api/package	-	application/json: CreatePackage text/json: CreatePackage application/*+json: CreatePackage	200 OK
PUT	/user-api/package-status/{key}	PUT /user-api/package-status/{key}	key (path, required, string)	application/json: UpdatePackageStatus text/json: UpdatePackageStatus application/*+json: UpdatePackageStatus	200 OK
DELETE	/user-api/package/{key}	DELETE /user-api/package/{key}	key (path, required, string)	-	200 OK
GET	/user-api/package/{key}	GET /user-api/package/{key}	key (path, required, string)	-	200 OK
PUT	/user-api/package/{key}	PUT /user-api/package/{key}	key (path, required, string)	application/json: UpdatePackage text/json: UpdatePackage application/*+json: UpdatePackage	200 OK
GET	/user-api/packages	GET /user-api/packages	page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string)	-	200 OK

8.4.9 Region

Method	Endpoint	Operation	Parameters	Request Body	Responses
POST	/user-api/region	POST /user-api/region	-	application/json: CreateRegion text/json: CreateRegion application/*+json: CreateRegion	200 OK
DELETE	/user-api/region/{key}	DELETE /user-api/region/{key}	key (path, required, string)	-	200 OK
GET	/user-api/region/{key}	GET /user-api/region/{key}	key (path, required, string)	-	200 OK
PUT	/user-api/region/{key}	PUT /user-api/region/{key}	key (path, required, string)	application/json: UpdateRegion text/json: UpdateRegion application/*+json: UpdateRegion	200 OK
GET	/user-api/regions	GET /user-api/regions	OrganizationId (query, required, string) page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string)	-	200 OK

8.4.10 RoleMapping

Method	Endpoint	Operation	Parameters	Request Body	Responses
POST	/user-api/role-mapping	POST /user-api/role-mapping	-	application/json: FeatureMappingDto text/json: FeatureMappingDto application/*+json: FeatureMappingDto	200 OK
GET	/user-api/role-mappings/{organizationId}	GET /user-api/role-mappings/{organizationId}	organizationId (path, required, string)	-	200 OK

8.4.11 UserAccess

Method	Endpoint	Operation	Parameters	Request Body	Responses
POST	/user-api/user-access	POST /user-api/user-access	-	application/json: UserRoleDto text/json: UserRoleDto application/*+json: UserRoleDto	200 OK
GET	/user-api/user-access/{userId}/{organizationId}	GET /user-api/user-access/{userId}/{organizationId}	organizationId (path, required, string) userId (path, required, string)	-	200 OK
GET	/user-api/user-access/validate/{userEmail}/{serviceName}/{requiredRole}	GET /user-api/user-access/validate/{userEmail}/{serviceName}/{requiredRole}	userEmail (path, required, string) serviceName (path, required, string) requiredRole (path, required, string)	-	200 OK

8.4.12 UserAccount

Method	Endpoint	Operation	Parameters	Request Body	Responses
PUT	/user-api/admin-change-password/{adminUserId}	PUT /user-api/admin-change-password/{adminUserId}	adminUserId (path, required, string)	application/json: ChangeUserPasswordByAdminDto text/json: ChangeUserPasswordByAdminDto application/*+json: ChangeUserPasswordByAdminDto	200 OK
PUT	/user-api/change-password/{key}	PUT /user-api/change-password/{key}	key (path, required, string)	application/json: ChangePasswordDto text/json: ChangePasswordDto application/*+json: ChangePasswordDto	200 OK
GET	/user-api/check-user-account/{userAccountId}	GET /user-api/check-user-account/{userAccountId}	userAccountId (path, required, string)	-	200 boolean OK
POST	/user-api/device-monitor/login	POST /user-api/device-monitor/login	-	application/json: LoginDto text/json: LoginDto application/*+json: LoginDto	200 ResponseDto OK
GET	/user-api/expert-users/{organizationId}	GET /user-api/expert-users/{organizationId}	organizationId (path, required, string) search (query, string)	-	200 OK
POST	/user-api/login	POST /user-api/login	-	application/json: AuthenticationRequest text/json: AuthenticationRequest application/*+json: AuthenticationRequest	200 OK
PUT	/user-api/logout	PUT /user-api/logout	-	application/json: LogoutDto text/json: LogoutDto application/*+json: LogoutDto	200 OK
POST	/user-api/rdp/login	POST /user-api/rdp/login	-	application/json: LoginDto text/json: LoginDto application/*+json: LoginDto	200 ResponseDto OK
POST	/user-api/refresh-token	POST /user-api/refresh-token	-	application/json: RefreshTokenDto text/json: RefreshTokenDto application/*+json: RefreshTokenDto	200 OK
POST	/user-api/user-account	POST /user-api/user-account	-	application/json: CreateUserAccountWithContact text/json: CreateUserAccountWithContact application/*+json: CreateUserAccountWithContact	200 OK
POST	/user-api/user-account-organization	POST /user-api/user-account-organization	-	application/json: CreateUserAccount text/json: CreateUserAccount application/*+json: CreateUserAccount	200 OK
DELETE	/user-api/user-account/{key}	DELETE /user-api/user-account/{key}	key (path, required, string)	-	200 OK
GET	/user-api/user-account/{key}	GET /user-api/user-account/{key}	key (path, required, string) organizationId (query, string)	-	200 OK
PUT	/user-api/user-account/{key}	PUT /user-api/user-account/{key}	key (path, required, string)	application/json: UpdateUserAccount text/json: UpdateUserAccount application/*+json: UpdateUserAccount	200 OK
GET	/user-api/user-account/email/{email}	GET /user-api/user-account/email/{email}	email (path, required, string)	-	200 OK
GET	/user-api/user-account/organization-admin/{organizationId}	GET /user-api/user-account/organization-admin/{organizationId}	organizationId (path, required, string)	-	200 OK
GET	/user-api/user-account/organization-concern/{organizationId}/{facilityId}/{serviceRoleType}	GET /user-api/user-account/organization-concern/{organizationId}/{facilityId}/{serviceRoleType}	organizationId (path, required, string) facilityId (path, required, string) serviceRoleType (path, required)	-	200 OK
GET	/user-api/user-account/swiched-organization/{key}/{organizationId}	GET /user-api/user-account/swiched-organization/{key}/{organizationId}	key (path, required, string) organizationId (path, required, string)	-	200 OK
GET	/user-api/user-account/userId-or-contactId/{key}	GET /user-api/user-account/userId-or-contactId/{key}	key (path, required, string)	-	200 OK
GET	/user-api/user-account/userId/{key}	GET /user-api/user-account/userId/{key}	key (path, required, string)	-	200 OK
GET	/user-api/user-accounts-by-type/{organizationId}	GET /user-api/user-accounts-by-type/{organizationId}	organizationId (path, required, string) userType (query) regionId (query, string) page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string)	-	200 OK
GET	/user-api/user-accounts/{organizationId}	GET /user-api/user-accounts/{organizationId}	organizationId (path, required, string) regionId (query, string) page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string)	-	200 OK
GET	/user-api/user-accounts/organizationId/{organizationId}	GET /user-api/user-accounts/organizationId/{organizationId}	organizationId (path, required, string)	-	200 OK
GET	/user-api/user-accounts/search-by-text/{organizationId}	GET /user-api/user-accounts/search-by-text/{organizationId}	organizationId (path, required, string) search (query, string)	-	200 OK

8.4.13 UserRequest

Method	Endpoint	Operation	Parameters	Request Body	Responses
POST	/user-api/internal-user-request	POST /user-api/internal-user-request	-	application/json: CreateInternalUserRequestDto text/json: CreateInternalUserRequestDto application/*+json: CreateInternalUserRequestDto	200 OK
POST	/user-api/internal-user-request/status-update	POST /user-api/internal-user-request/status-update	-	application/json: InternalUserRequestStatusUpdateDto text/json: InternalUserRequestStatusUpdateDto application/*+json: InternalUserRequestStatusUpdateDto	200 OK
POST	/user-api/password-recovery-request	POST /user-api/password-recovery-request	-	application/json: RecoveryRequestDto text/json: RecoveryRequestDto application/*+json: RecoveryRequestDto	200 OK
DELETE	/user-api/remove-user-requests	DELETE /user-api/remove-user-requests	-	application/json: DeleteUserRequest text/json: DeleteUserRequest application/*+json: DeleteUserRequest	200 OK
POST	/user-api/reset-password-by-recovery-request	POST /user-api/reset-password-by-recovery-request	-	application/json: ResetPasswordByRecoveryRequestDto text/json: ResetPasswordByRecoveryRequestDto application/*+json: ResetPasswordByRecoveryRequestDto	200 OK
POST	/user-api/user-request	POST /user-api/user-request	-	application/json: CreateUserRequestDto text/json: CreateUserRequestDto application/*+json: CreateUserRequestDto	200 OK
POST	/user-api/user-request/set-password/{userRequestId}	POST /user-api/user-request/set-password/{userRequestId}	userRequestId (path, required, string)	application/json: SetPasswordDto text/json: SetPasswordDto application/*+json: SetPasswordDto	200 OK
POST	/user-api/user-request/status-update	POST /user-api/user-request/status-update	-	application/json: UserRequestStatusUpdateDto text/json: UserRequestStatusUpdateDto application/*+json: UserRequestStatusUpdateDto	200 OK
GET	/user-api/user-requests	GET /user-api/user-requests	page (query, integer) pageSize (query, integer) search (query, string) sort (query, string) sortDirection (query, string) organizationId (query, string)	-	200 OK

---

8.5 Common Schemas and Enums

Schemas below are generated from the OpenAPI component definitions. They are grouped by API and should be used when preparing payloads or validating responses.

8.5.1 Ticketing API Schemas

Schema	Type	Required Fields	Fields / Values
ActionType	enum	-	1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
BooleanApiResponse	object	-	isSuccess: boolean data: boolean message: string httpStatusCode: HttpStatusCode
BulkBranchStatusDto	object	-	modifiedBy: string organizationId: string branchId: array<integer> isActive: boolean
ClosedIncident	object	-	incidentId: array<IncidenKey>
ContactDto	object	-	oid: string contactFullName: string contactEmail: string companyId: string contactPhone: string organizationId: string
CreateApplication	object	name	createdBy: string organizationId: string name: string
CreateBranch	object	name	createdBy: string organizationId: string name: string description: string isActive: boolean
CreateBranchPermission	object	branchId	createdBy: string organizationId: string branchId: integer userAccountId: string isActive: boolean
CreateCategory	object	isSubCategory, name	createdBy: string organizationId: string name: string description: string isSubCategory: boolean parentCategoryId: integer
CreateIdentifiedAssignedIncident	object	incidentId	createdBy: string organizationId: string oid: string description: string dateIdentified: string allowAccess: boolean incidentId: string expertId: string
CreateIdentifiedCategory	object	categoryId	createdBy: string organizationId: string categoryId: integer teamId: integer
CreatePriorityConfigurationDto	object	createdBy, priority, timeInMinutes	priority: TicketPriority timeInMinutes: number createdBy: string
CreateTeam	object	name	createdBy: string organizationId: string name: string description: string isAssigned: boolean
CreateTeamMember	object	-	createdBy: string organizationId: string userId: string teamId: integer isTeamLead: boolean isPrimaryTeam: boolean
DashboardTimeFilter	enum	-	1, 2, 3, 4, 5
DeleteAttachmentDto	object	-	attachmentId: array<integer>
ExtensionDto	object	-	oid: string extentionName: string extention: string organizationId: string
HttpStatusCode	enum	-	100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 306, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, 511
IncidenKey	object	-	incidentId: string
IncidentCreateMethod	enum	-	1, 2, 3, 4, 5
IncidentDto	object	categoryId, description, facilityId, ticketTitle	createdBy: string organizationId: string oid: string ticketTitle: string description: string facilityId: string dateResolved: string isAssigned: boolean incidentStatus: IncidentStatus incidentSource: SourceOfIncident incidentCreateMethod: IncidentCreateMethod dueDate: string incidentPriority: TicketPriority brandName: string branchId: integer contactId: string expertId: string slNumber: string ...7 more
IncidentStatus	enum	-	0, 1, 2, 3, 4, 5, 6
IncidentStatusDto	object	-	organizationId: string incidentStatus: IncidentStatus incidentId: string modifiedBy: string
Message	object	-	createdBy: string dateCreated: string modifiedBy: string dateModified: string organizationId: string isDeleted: boolean isSynced: boolean isTPSynced: boolean isArchived: boolean oid: string messageDate: string description: string isInternal: boolean isResolution: boolean isOpen: boolean incidentId: string emailMessageId: string
MessageApiResponse	object	-	isSuccess: boolean data: Message message: string httpStatusCode: HttpStatusCode
MessageDto	object	-	createdBy: string dateCreated: string modifiedBy: string dateModified: string organizationId: string isDeleted: boolean isSynced: boolean isTPSynced: boolean isArchived: boolean oid: string messageDate: string description: string isInternal: boolean isResolution: boolean isOpen: boolean incidentId: string
MessageDtoApiResponse	object	-	isSuccess: boolean data: MessageDto message: string httpStatusCode: HttpStatusCode
ObjectIEnumerableApiResponse	object	-	isSuccess: boolean data: array<object> message: string httpStatusCode: HttpStatusCode
RemoveTeamMemberDto	object	-	modifiedBy: string organizationId: string oid: array<integer>
SourceOfIncident	enum	-	1, 2, 3, 4, 5
TeamTransferDto	object	-	createdBy: string dateCreated: string modifiedBy: string dateModified: string organizationId: string isDeleted: boolean isSynced: boolean isTPSynced: boolean isArchived: boolean incidentId: string teamId: integer expertId: string
TextCorrectionRequestDto	object	-	text: string
TicketPriority	enum	-	1, 2, 3, 4
UpdateApplication	object	name	id: string name: string
UpdateBranch	object	name, oid	modifiedBy: string organizationId: string oid: integer name: string description: string isActive: boolean
UpdateBranchPermission	object	branchId, oid	modifiedBy: string organizationId: string oid: integer branchId: integer userAccountId: string isActive: boolean
UpdateCategory	object	name, oid	modifiedBy: string organizationId: string oid: integer name: string description: string isSubCategory: boolean parentCategoryId: integer
UpdateIdentifiedAssignedIncident	object	oid	modifiedBy: string organizationId: string oid: string description: string dateIdentified: string allowAccess: boolean incidentId: string teamId: integer expertId: string
UpdateIdentifiedCategory	object	categoryId, oid	modifiedBy: string organizationId: string oid: integer categoryId: integer teamId: integer
UpdateTeam	object	name, oid	modifiedBy: string organizationId: string oid: integer name: string description: string isAssigned: boolean
UpdateTeamMember	object	-	modifiedBy: string organizationId: string oid: integer userId: string teamId: integer isTeamLead: boolean isPrimaryTeam: boolean

8.5.2 User API Schemas

Schema	Type	Required Fields	Fields / Values
ActionType	enum	-	1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
AssignDepartmentDto	object	-	createdBy: string organizationId: string departmentId: string users: array<string>
AuthenticationRequest	object	-	email: string password: string
AutomationChannelDto	object	-	channel: NotificationChannel roles: array<NotificationRole>
AutomationRuleDto	object	-	oid: string serviceType: Service eventType: EventTypes isCreate: boolean autoAssignTime: integer description: string automationChannels: array<AutomationChannelDto>
AutomationRuleRequestDto	object	-	automationRules: array<AutomationRuleDto> createdBy: string organizationId: string
ChangePasswordDto	object	confirmPassword, oldPassword	email: string organizationId: string oldPassword: string newPassword: string confirmPassword: string
ChangeUserPasswordByAdminDto	object	confirmPassword	userId: string newPassword: string confirmPassword: string
ContactDto	object	-	oid: string contactFullName: string contactEmail: string contactPhone: string companyId: string organizationId: string
ContactLoginDto	object	email, organizationId, password	email: string password: string organizationId: string
CreateAssignedOrganizationService	object	-	createdBy: string organizationId: string services: array<Service>
CreateAssignUserDepartmentDto	object	-	createdBy: string organizationId: string departmentId: string userId: string
CreateAutomationRuleDto	object	automationRulesRequest	automationRulesRequest: array<AutomationRuleRequestDto>
CreateAutomationRuleDtoApiResponse	object	-	isSuccess: boolean data: CreateAutomationRuleDto message: string httpStatusCode: HttpStatusCode
CreateCompany	object	name	createdBy: string organizationId: string name: string description: string address: string primaryPhone: string secondaryPhoneNumber: string email: string website: string facebookPageUrl: string linkedInPageUrl: string facilityCode: string regionId: string
CreateContact	object	fullName	createdBy: string organizationId: string fullName: string email: string phone: string companyId: string password: string
CreateDepartmentDto	object	departmentName	createdBy: string organizationId: string departmentName: string description: string
CreateInternalUserRequestDto	object	-	organizationId: string email: string
CreateOrganization	object	expiryDate, isActive, name	createdBy: string organizationId: string name: string address: string city: string state: string expiryDate: string contactNumber: string isActive: boolean
CreatePackage	object	description, title	title: string description: string isActive: boolean packageFeatures: array<PackageFeature>
CreateRegion	object	-	createdBy: string organizationId: string name: string
CreateUserAccount	object	email, firstName, password	createdBy: string organizationId: string firstName: string surname: string gender: Gender dateOfBirth: string email: string countryCode: string cellphone: string address: string password: string regionId: string
CreateUserAccountWithContact	object	email, firstName, organizationId, password, userType	firstName: string surname: string gender: Gender dateOfBirth: string email: string countryCode: string cellphone: string address: string password: string regionId: string companyId: string userType: UserType organizationId: string
CreateUserRequestDto	object	email, firstName, organizationName	organizationName: string firstName: string surname: string email: string countryCode: string cellphone: string
DeleteAssignedOrganizationService	object	-	organizationId: string services: array<Service>
DeleteUserRequest	object	-	requestId: array<string>
EventTypes	enum	-	0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 21, 22, 23, 41, 42, 43, 44, 45, 46, 61, 62, 63, 64, 65
ExistingAutomationDto	object	-	channel: NotificationChannel role: NotificationRole isCreate: boolean
Feature	object	-	featureName: FeatureName actions: array<ActionType>
FeatureMappingDto	object	-	organizationId: string userId: string roles: array<RoleDto>
FeatureName	enum	-	1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62
Gender	enum	-	1, 2, 3
GetExistingAutomationDto	object	-	notifications: array<ExistingAutomationDto>
GetExistingAutomationDtoApiResponse	object	-	isSuccess: boolean data: GetExistingAutomationDto message: string httpStatusCode: HttpStatusCode
HttpStatusCode	enum	-	100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 306, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, 511
InActiveUserFromOrganizationDto	object	-	organizationId: string userId: string active: boolean
InternalUserRequestStatusUpdateDto	object	accept, userRequestId	userRequestId: string accept: boolean
LinkWhatsAppDto	object	-	phoneId: string wabaId: string
LoginDto	object	email, password	email: string password: string
LogoutDto	object	-	userId: string
NotificationChannel	enum	-	0, 1, 2, 3
NotificationRole	enum	-	0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 12
PackageFeature	object	description	description: string
RecoveryRequestDto	object	email, firstName	firstName: string surName: string email: string
RefreshTokenDto	object	-	refreshToken: string
ResetPasswordByRecoveryRequestDto	object	confirmPassword, newPassword	userRequestId: string newPassword: string confirmPassword: string
ResponseDto	object	-	statusCode: HttpStatusCode message: string data: object isSuccess: boolean
RoleDto	object	-	role: ServiceRoleType features: array<Feature>
Service	enum	-	0, 1, 2, 3, 4, 5, 6, 7, 8, 100
ServiceRole	object	-	service: Service roles: ServiceRoleType
ServiceRoleType	enum	-	1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
SetPasswordDto	object	confirmPassword	userRequestId: string newPassword: string confirmPassword: string
UpdateCompany	object	name, oid	modifiedBy: string organizationId: string oid: string name: string description: string address: string primaryPhone: string secondaryPhoneNumber: string email: string website: string facebookPageUrl: string linkedInPageUrl: string facilityCode: string regionId: string
UpdateContact	object	fullName, oid	modifiedBy: string organizationId: string oid: string fullName: string email: string phone: string companyId: string password: string
UpdateDepartmentDto	object	departmentName, oid	modifiedBy: string organizationId: string oid: string departmentName: string description: string
UpdateOrganization	object	expiryDate, isActive, name, oid, userId	oid: string name: string address: string city: string state: string expiryDate: string contactNumber: string isActive: boolean organizationSuffix: string isPublicPortalConfigured: boolean userId: string
UpdateOrganizationByOrganizationAdmin	object	name, oid, userId	oid: string name: string address: string city: string state: string contactNumber: string organizationSuffix: string isPublicPortalConfigured: boolean userId: string
UpdatePackage	object	description, oid, title	oid: string title: string isActive: boolean description: string packageFeatures: array<PackageFeature>
UpdatePackageStatus	object	oid	oid: string isActive: boolean
UpdateRegion	object	id, name	id: string name: string
UpdateUserAccount	object	email, firstName, oid	modifiedBy: string organizationId: string oid: string firstName: string surname: string gender: Gender dateOfBirth: string email: string countryCode: string cellphone: string address: string regionId: string userType: UserType
UserRequestStatusUpdateDto	object	requestStatus, userRequestId	userRequestId: string requestStatus: UserRuquestStatus
UserRoleDto	object	-	userId: string organizationId: string createdBy: string serviceRoles: array<ServiceRole>
UserRuquestStatus	enum	-	1, 2, 3, 4, 5, 6
UserType	enum	-	1, 2, 3, 4

---

8.6 Integration Notes

• Use the User API for authentication, user accounts, contacts, roles, organizations, departments, regions, packages, automation rules, and user requests.
• Use the Ticketing API for branches, categories, incidents/tickets, assignments, attachments, messages, priority configuration, reports, report files, teams, and AI/application support endpoints.
• Report and report-file endpoints are part of the Ticketing API and support the documentation menu item 4. Reports.
• File upload/download behavior should be verified against the deployed storage provider and maximum upload policy before go-live.
• Exact production base URLs depend on the IIS or Portainer reverse-proxy configuration documented in the installation manual.

---

8.7 Verification Checklist

Test	Expected Result
Authenticate with User API	Valid users receive a token or expected login response.
Create/update users	Administrator can create and maintain user accounts.
Configure regions and organizations	Region and organization endpoints return saved values.
Create ticket category	Ticketing API stores category and returns it in category list.
Create incident/ticket	Ticketing API creates a new ticket with expected status and identifiers.
Assign ticket	Assignment endpoints update responsible team/user.
Add message	Message appears in ticket conversation.
Upload/list attachment	Attachment is stored and returned by attachment endpoint.
Generate reports	Report endpoints return filtered report data.