- Using API Keys
- v1
- Activities
- Approvals
- Attachments
- Categories
- Comments
- Creates a new comment.
- Retrieves a specific comment by its ID.
- Retrieves comments associated with a specific activity ID.
- Retrieves comments associated with a specific approval ID.
- Retrieves comments associated with a specific ticket ID.
- Retrieves comments by type (e.g., ticket, activity, or approval).
- Retrieves a comment with a specific template applied.
- Retrieves the total number of comments by type (e.g., ticket, activity, or approval).
- Updates a comment.
- Contacts
- Histories
- Innovation
- MasterTypes
- Retrieves all business unit support by company ID.
- Retrieves all categories by team name.
- Retrieves all configuration tickets by company ID and department ID.
- Retrieves all customers by search text.
- Retrieves all scope categories by team name, category name, and subcategory name.
- Retrieves all subcategories by team name and category name.
- Retrieves all master types.
- Retrieves a master type by its ID.
- Retrieves a master type by its name.
- Retrieves master types by their parent ID.
- Retrieves master types by their parent name.
- News
- Notification
- OutSite
- Rank
- Retrieves the current agent scores for the current week.
- Retrieves the average score chart for a specific agent by email.
- Retrieves the current rank history for the previous week.
- Retrieves the rank history for a specific year and week number.
- Retrieves the agent scores for a specific year and week number.
- SubscriptionKeys
- Creates a new subscription key
- Gets all subscription keys
- Deletes a subscription key (actually deactivates it)
- Gets a subscription key by ID
- Updates a subscription key
- Gets usage summary for subscription keys
- Regenerates a new key value for an existing subscription key
- Activates or deactivates a subscription key
- Validates a subscription key
- Templates
- Tickets
- Authenticates a ticket for rating based on a provided token.
- Clones an existing ticket based on the provided ticket ID.
- Creates a new ticket based on the provided details.
- Creates a new ticket based on a comment.
- Retrieves a paginated list of all tickets by page and quantity, filtered by view name.
- Retrieves the total number of tickets based on the provided filter.
- Retrieves the number of tickets grouped by their state, created within the specified date range.
- Retrieves the customer rating for a specific ticket by its ID.
- Retrieves a ticket by its conversation ID.
- Retrieves a ticket by its ID.
- Retrieves a paginated list of tickets based on the provided filters and sorting options.
- Retrieves tickets associated with a specific customer email.
- Retrieves a paginated list of tickets associated with a specific customer email.
- Retrieves tickets associated with a specific team owner.
- Retrieves tickets associated with a specific ticket owner.
- Retrieves tickets by a specific view name.
- Retrieves the total number of tickets based on the provided filters.
- Retrieves the total number of tickets based on the specified view name.
- Merges selected tickets into a base ticket.
- Merges multiple tickets into a single ticket.
- Rates a ticket based on the provided token, work quality, duration, and optional comment.
- Rates a ticket based on the provided ticket ID, work quality, duration, and optional comment.
- Searches for tickets by their subject or ID.
- Updates the status of a ticket.
- Updates an existing ticket with the provided details.
- Updates the category of a ticket.
- Updates the department of a ticket.
- Updates the owner of a ticket.
- Updates the subcategory of a ticket.
- Updates the team owner of a ticket.
- Users
- Retrieves agent information by email.
- Retrieves contacts by company.
- Retrieves the current user's information.
- Retrieves departments by company.
- Retrieves the user information for the current user.
- Retrieves users by company.
- Retrieves users by team within a department.
- Retrieves users by department within a company.
- Logs in the user using OTP.
- Requests a login OTP for the user.
- Signs up a new user and requests an OTP.
- Test method to demonstrate caching.
- Verifies a user using OTP and activates the user.
- v2
- Approval
- Innovation
- Ticket
- Creates a new support ticket
- Retrieves tickets with filtering and sorting capabilities (Optimized with DTO)
- Retrieves detailed tickets with filtering and sorting capabilities
- Gets available filter options for tickets (for building dynamic filter UIs)
- /Tickets/{ticketId}/comments
- Gets the total count of tickets matching the specified filter criteria
- Retrieves a paginated list of tickets with detailed information including related data (Optimized with DetailDTO)
- Retrieves a paginated list of tickets with advanced filtering and sorting capabilities (Optimized with DTO)
- [LEGACY] Retrieves tickets with full entity objects (use DTO endpoints for better performance)
- Updates a single property on a ticket by name
- User
- Template
- Comments
- Master
- Attachment
- Schemas
- Schemas
- Activity
- CreatedTicket
- CreateTicketFromComment
- NotificationModel
- TemplateDto
- ActivityEntity
- Approval
- Agent
- UserRequest
- TemplateRequest
- ActivitySummaryDTOViewModel
- Attachment
- AgentRole
- TicketRequest
- AgentDropdownItem
- AddAgentRequestRequest
- AgentScore
- AttachmentMailReply
- AgentDropdownItemIEnumerableApiResponse
- AgentScoreClass
- AgentScoreListApiResponse
- Comment
- ApiResponseOfCompanyAndDepartmentTeamUsersClass_8694
- AgentEntity
- CommentRequest
- BUSupport
- ApiResponseOfDepartmentAndConfigTicketClass_2345
- AgentRoleEntity
- History
- Category
- ApprovalForView
- ApiResponseOfApprovalForViewClass_5303
- ApiResponseOfApprovalForViewClass_1419
- ApiResponseOfApprovalForViewClass_6449
- ApiResponseOfDepartmentAndTeamUsersClass_719
- ApiResponseOfApprovalForViewClass_4495
- ApiResponseOfApprovalCountersResponseViewModel
- HistoryInfo
- CloneTicketRequest
- ApprovalForViewApiResponse
- ApiResponseOfIEnumerableOfAgentDropdownItem_6154
- ApiResponseOfIEnumerableOfAgentDropdownItem_9170
- ApiResponseOfIEnumerableOfAgentDropdownItem_1550
- ApiResponseOfDeskUserClass_5540
- ApiResponseOfIEnumerableOfAgentDropdownItem_8596
- ApiResponseOfApprovalDetailResponseViewModel
- MailReplyRequest
- ApprovalForViewListApiResponse
- ApiResponseOfListOfAgentScoreClass_7875
- ApiResponseOfApprovalEntity
- ApiResponseOfInt
- Company
- ApprovalGroupNotify
- ApiResponseOfListOfApprovalForViewClass_5724
- ApiResponseOfListOfApprovalForViewClass_8760
- ApiResponseOfListOfApprovalForViewClass_1133
- ApiResponseOfListOfContactDtoClass_2200
- ApiResponseOfListOfApprovalForViewClass_2144
- ApiResponseOfBulkUpdateApprovalStatusResponseViewModel
- ParentType
- ApiResponseOfBool
- CategoryForView
- Ticket
- StringStringListKeyValuePair
- Contact
- ApprovalGroupNotifyListApiResponse
- ApiResponseOfListOfApprovalGroupNotifyClass_2809
- ApiResponseOfListOfApprovalGroupNotifyClass_2992
- ApiResponseOfListOfApprovalGroupNotifyClass_8449
- ApiResponseOfListOfCustomerEntity_9871
- ApiResponseOfListOfApprovalGroupNotifyClass_4352
- ApiResponseOfIEnumerableOfAgentDropdownItem_1139
- ApiResponseOfIEnumerableOfAgentDropdownItem_1793
- ApiResponseOfIEnumerableOfAgentDropdownItem_1803
- ApprovalNotify
- ApiResponseOfListOfApprovalWithSubjectViewViewModel_3183
- ApiResponseOfListOfApprovalWithSubjectViewViewModel_445
- ApiResponseOfListOfApprovalWithSubjectViewViewModel_854
- ApiResponseOfListOfDepartmentForViewClass_1665
- ApiResponseOfListOfApprovalWithSubjectViewViewModel_2376
- ApiResponseOfIEnumerableOfAgentDropdownItem_4958
- ApiResponseOfIEnumerableOfAgentDropdownItem_2000
- CustomField
- ContactDto
- CompanyDto
- ApprovalWithSubjectView
- ApiResponseOfListOfTemplateDto_2926
- ApiResponseOfListOfTemplateDto_8412
- ApiResponseOfListOfTemplateDto_8712
- ApiResponseOfListOfHistoryForViewClass_5890
- ApiResponseOfListOfTemplateDto_4466
- ApiResponseOfListOfApprovalForViewClass_8313
- ApiResponseOfListOfApprovalForViewClass_6479
- ApiResponseOfListOfApprovalForViewClass_1406
- ContactDtoApiResponse
- TicketMerges
- TicketMerge
- CustomFieldValue
- Component
- ApprovalWithSubjectViewListApiResponse
- ApiResponseOfListOfTicketDTOViewModel_2646
- ApiResponseOfListOfTicketDTOViewModel_5904
- ApiResponseOfListOfTicketDTOViewModel_309
- ApiResponseOfListOfMasterTypeEntity_251
- ApiResponseOfListOfTicketDTOViewModel_4093
- ApiResponseOfListOfApprovalGroupNotifyClass_7956
- ApiResponseOfListOfApprovalGroupNotifyClass_9347
- ApiResponseOfListOfApprovalGroupNotifyClass_7738
- ApiResponseOfListOfApprovalForViewClass_6632
- ApiResponseOfListOfApprovalForViewClass_5304
- Department
- ContactRequest
- ApiResponseOfListOfTicketDetailDTOViewModel_6383
- ApiResponseOfListOfTicketDetailDTOViewModel_6412
- ApiResponseOfListOfTicketDetailDTOViewModel_9984
- ApiResponseOfListOfRankHistoryEntity_4901
- ApiResponseOfListOfTicketDetailDTOViewModel_8339
- ApiResponseOfListOfApprovalStatusMasterItemViewModel_6356
- ApiResponseOfListOfApprovalStatusMasterItemViewModel_1233
- ApiResponseOfListOfApprovalStatusMasterItemViewModel_8932
- ApiResponseOfListOfApprovalGroupNotifyClass_5838
- ApiResponseOfListOfApprovalGroupNotifyClass_7033
- CompanyAndDepartmentTeamUsers
- AttachmentForView
- ApiResponseOfMailReplyResponseV2Class_6835
- ApiResponseOfMailReplyResponseV2Class_7282
- ApiResponseOfMailReplyResponseV2Class_2835
- ApiResponseOfListOfSubscriptionKeyDto_6377
- ApiResponseOfMailReplyResponseV2Class_6037
- ApiResponseOfListOfCommentForViewClass_3738
- ApiResponseOfListOfCommentForViewClass_8415
- ApiResponseOfListOfCommentForViewClass_5926
- ApiResponseOfListOfApprovalStatusMasterItemViewModel_2692
- ApiResponseOfListOfApprovalStatusMasterItemViewModel_9210
- CompanyAndDepartmentTeamUsersApiResponse
- ApiResponseOfListOfSubscriptionKeyUsageSummaryDto_9445
- ApiResponseOfListOfTemplateDto_6409
- ApiResponseOfListOfTemplateDto_2104
- ApiResponseOfObject
- ApiResponseOfListOfTemplateDto_7734
- ApiResponseOfListOfCommentForViewClass_2942
- ApiResponseOfListOfCommentForViewClass_3155
- ApiResponseOfPagedResultOfTicketDTOViewModel_9998
- ApiResponseOfPagedResultOfTicketDTOViewModel_5689
- ApiResponseOfPagedResultOfTicketDTOViewModel_2148
- ApiResponseOfListOfTemplateDto_7475
- ApiResponseOfPagedResultOfTicketDTOViewModel_1669
- ApiResponseOfListOfTicketDTOViewModel_1026
- ApiResponseOfListOfTicketDTOViewModel_2650
- ApiResponseOfListOfTicketDTOViewModel_7368
- ApiResponseOfListOfTemplateDto_5759
- ApiResponseOfListOfTemplateDto_8033
- ApiResponseOfPagedResultOfTicketDetailDTOViewModel_6016
- ApiResponseOfPagedResultOfTicketDetailDTOViewModel_4528
- ApiResponseOfPagedResultOfTicketDetailDTOViewModel_2477
- ApiResponseOfListOfTemplateEntity_6294
- ApiResponseOfPagedResultOfTicketDetailDTOViewModel_9147
- ApiResponseOfListOfTicketDetailDTOViewModel_2930
- ApiResponseOfListOfTicketDetailDTOViewModel_8171
- ApiResponseOfListOfTicketDetailDTOViewModel_7833
- ApiResponseOfListOfTicketDTOViewModel_8376
- ApiResponseOfListOfTicketDTOViewModel_9459
- Rank
- Customer
- CommentForView
- ApiResponseOfPagedResultOfTicketEntity_6087
- ApiResponseOfPagedResultOfTicketEntity_3776
- ApiResponseOfPagedResultOfTicketEntity_1351
- ApiResponseOfMasterTypeEntity
- ApiResponseOfPagedResultOfTicketEntity_113
- ApiResponseOfMailReplyResponseV2Class_8641
- ApiResponseOfMailReplyResponseV2Class_3571
- ApiResponseOfMailReplyResponseV2Class_3750
- ApiResponseOfListOfTicketDetailDTOViewModel_9262
- ApiResponseOfListOfTicketDetailDTOViewModel_7975
- RankHistory
- ApiResponseOfString
- ApiResponseOfMailReplyResponseV2Class_8100
- ApiResponseOfMailReplyResponseV2Class_680
- ContactDtoListApiResponse
- RateConfiguration
- DepartmentDto
- ApiResponseOfPagedItemsOfApprovalListItemViewModel_6158
- ApiResponseOfPagedItemsOfApprovalListItemViewModel_918
- ApiResponseOfTemplateDto
- ApiResponseOfPagedItemsOfApprovalListItemViewModel_9055
- Role
- LoginModel
- DeskUser
- ObjectApiResponse
- ApiResponseOfSubscriptionKeyDto
- ApiResponseOfPagedResultOfTicketDTOViewModel_2813
- ApiResponseOfPagedResultOfTicketDTOViewModel_964
- ApiResponseOfTicketEntity
- ApiResponseOfPagedResultOfTicketDTOViewModel_9984
- ApiResponseOfPagedItemsOfApprovalListItemViewModel_2151
- ApiResponseOfPagedItemsOfApprovalListItemViewModel_9855
- CreateSubscriptionKeyDto
- ApiResponseOfSubscriptionKeyValidationResultDto
- ApiResponseOfPagedResultOfTicketDetailDTOViewModel_3112
- ApiResponseOfPagedResultOfTicketDetailDTOViewModel_1576
- ApiResponseOfUserResponse
- ApiResponseOfPagedResultOfTicketDetailDTOViewModel_6440
- ApiResponseOfPagedResultOfTicketDTOViewModel_755
- ApiResponseOfPagedResultOfTicketDTOViewModel_707
- Team
- NotificationType
- ApiResponseOfTeamAndUsersClass_5685
- ApiResponseOfPagedResultOfTicketEntity_6717
- ApiResponseOfPagedResultOfTicketEntity_1143
- ApprovalEntity
- ApiResponseOfPagedResultOfTicketEntity_753
- ApiResponseOfPagedResultOfTicketDetailDTOViewModel_8021
- ApiResponseOfPagedResultOfTicketDetailDTOViewModel_1731
- TeamAgent
- Function
- ApiResponseOfTemplateDTOViewModel
- ApprovalForViewClass
- ApiResponseOfPagedResultOfTicketEntity_7960
- Template
- ApprovalGroupNotifyClass
- TemplateControl
- OutSiteRequest
- ApiResponseOfTicketScoreAvgChartClass_5908
- ApprovalNotifyClass
- ApiResponseOfTicketDTOViewModel
- TemplateControlOption
- StatusResponse
- ApprovalSummaryDTOViewModel
- CustomerListApiResponse
- ApprovalWithSubjectViewViewModel
- ApprovalCountersResponseViewModel
- RequestLoginModel
- ApprovalDetailResponseViewModel
- AttachmentEntity
- DepartmentAndConfigTicket
- AttachmentForViewClass
- DepartmentAndConfigTicketApiResponse
- Trophy
- Int32ApiResponse
- AttachmentMailReplyClass
- DepartmentAndTeamUsers
- TrophyHistory
- SignUpRequest
- BUSupportEntity
- RateCustomerTicket
- DepartmentAndTeamUsersApiResponse
- CategoryForViewClass
- ApprovalListItemViewModel
- CategoryEntity
- RankDto
- CloneTicketRequestViewModel
- CommentEntity
- DepartmentForView
- ApprovalStatusMasterItemViewModel
- CommentForViewClass
- StringStringValueTuple
- DepartmentForViewListApiResponse
- CommentSummaryDTOViewModel
- CommentRequestViewModel
- TeamCustomer
- PagedTicketRequest
- CompanyAndDepartmentTeamUsersClass
- CompanyDtoDTO
- DeskUserApiResponse
- CompanyEntity
- RoleFunction
- PaginationRequest
- ComponentEntity
- ContactEntity
- HistoryForView
- BulkUpdateApprovalStatusRequestViewModel
- CustomFieldEntity
- ContactDtoClass
- HistoryForViewListApiResponse
- BulkUpdateApprovalStatusResponseViewModel
- CustomFieldValueEntity
- ContactRequestClass
- BulkUpdateApprovalStatusResultViewModel
- CustomerEntity
- HistoryInfoForView
- CreateSubscriptionKeyDtoDTO
- DepartmentDtoDTO
- CreateTicketFromCommentViewModel
- DepartmentEntity
- TicketForView
- TeamDto
- CreatedTicketViewModel
- FunctionEntity
- TicketForViewListApiResponse
- MasterType
- TicketApiResponse
- MailReplyRequestV2
- HistoryEntity
- MasterTypeApiResponse
- MailReplyResponseV2
- HistoryInfoEntity
- MasterTypeListApiResponse
- MailReplyResponseV2ApiResponse
- SortDirection
- HistorySummaryDTOViewModel
- MastertypeForView
- KeyValuePairOfStringAndListOfString_8440
- KeyValuePairOfStringAndListOfString_4575
- KeyValuePairOfStringAndListOfString_8713
- DepartmentAndConfigTicketClass
- KeyValuePairOfStringAndListOfString_5858
- DepartmentAndTeamUsersClass
- MailReplyRequestV2Class
- MailReplyResponseV2Class
- PagedResultOfTicketDTOViewModel
- DepartmentForViewClass
- CreateApprovalRequestViewModel
- PagedResultOfTicketDetailDTOViewModel
- UserResponse
- PaginationInfo
- PagedResultOfTicketEntity
- DeskUserClass
- UserResponseApiResponse
- PagedTicketRequestRequest
- ProblemDetails
- HistoryForViewClass
- DepartmentDtoClass
- PaginationRequestRequest
- HistoryInfoForViewClass
- RankDtoDTO
- RankHistoryListApiResponse
- KeyValuePairOfStringAndListOfString_7483
- RankEntity
- LoginModelClass
- RankHistoryEntity
- MailReplyRequestClass
- RateConfigurationEntity
- MasterTypeEntity
- ReplyMailOptionsV2Class
- MastertypeForViewClass
- ReplyModeClass
- ReplyMailOptionsV2
- NotificationModelClass
- KeyValuePairOfStringAndListOfString_6859
- KeyValuePairOfStringAndListOfString_5394
- RoleEntity
- KeyValuePairOfStringAndListOfString_1012
- KeyValuePairOfStringAndListOfString_1997
- ReplyMode
- TicketFilterRequest
- NotificationTypeClass
- RoleFunctionEntity
- KeyValuePairOfStringAndListOfString_1559
- StringApiResponse
- TicketListApiResponse
- OutSiteRequestRequest
- SortDirectionRequest
- TicketPagedResult
- PagedItemsOfApprovalListItemViewModel
- SubscriptionKey
- TicketPagedResultApiResponse
- SubscriptionKeyEntity
- SubscriptionKeyDto
- TeamAgentEntity
- SubscriptionKeyDtoApiResponse
- TicketSortRequest
- TeamCustomerEntity
- SubscriptionKeyDtoListApiResponse
- TeamDtoDTO
- SubscriptionKeyLog
- TeamEntity
- SubscriptionKeyUsage
- TemplateControlEntity
- SubscriptionKeyUsageSummaryDto
- RequestLoginModelClass
- TemplateControlOptionEntity
- SubscriptionKeyUsageSummaryDtoListApiResponse
- TemplateDtoDTO
- SubscriptionKeyValidationResultDto
- TemplateEntity
- SubscriptionKeyValidationResultDtoApiResponse
- SignUpRequestRequest
- TemplateRequestRequest
- TicketDTOViewModel
- SubscriptionKeyDtoDTO
- RateCustomerTicketViewModel
- TicketDetailDTOViewModel
- TeamAndUsers
- TicketEntity
- TeamAndUsersApiResponse
- SubscriptionKeyUsageSummaryDtoDTO
- TicketFilterRequestRequest
- SubscriptionKeyValidationResultDtoDTO
- TicketRequestRequest
- TicketSortRequestRequest
- TeamForView
- TeamAndUsersClass
- TrophyEntity
- TrophyHistoryEntity
- UserRequestRequest
- UpdateTicketPropertyRequestRequest
- TemplateControlDTO
- UserResponseResponse
- TeamForViewClass
- TemplateControlOptionDTO
- TemplateControlDTOViewModel
- TemplateDTO
- TemplateDTOApiResponse
- TemplateControlOptionDTOViewModel
- TemplateDtoApiResponse
- TemplateDTOViewModel
- TemplateDtoListApiResponse
- TemplateListApiResponse
- TicketMergeClass
- TicketMergesClass
- TicketScoreAvgChart
- TicketScoreAvgChartClass
- TicketForViewClass
- TicketScoreAvgChartApiResponse
- UpdateSubscriptionKeyDtoDTO
- UpdateSubscriptionKeyDto
- UpdateApprovalRequestViewModel
- WeeklyAbilityDTOClass
- WeeklyAbilityDTO
SubscriptionKeyUsageSummaryDto
{
"keyId": 0,
"keyValue": "string",
"name": "string",
"ownerId": 0,
"ownerName": "string",
"totalRequests": 0,
"successfulRequests": 0,
"failedRequests": 0,
"rateLimitExceeded": 0,
"avgResponseTime": 0,
"successRate": 0,
"lastUsedDate": "2019-08-24T14:15:22.123Z"
}