Tikit API Collection
The Tikit API can help with any task related to managing tickets, users, and other configuration data in your Tikit tenant. This document provides instruction, examples and the ability to try each endpoint with your provided Security token. Bear in mind that when executing the endpoints, they will affect your LIVE Tikit system. If you create a Ticket or a User, it will be created in Tikit. You can download the postman collection for this API here.
Version: 1.0.0
Approvals
GET
https://app.tikit.ai/api/Approvals
Get Approvals
This endpoint, with no filter criteria or any other parameters, will return an array of all approvals and properties. Approvers and tickets can be linked to approvals via the "Get Approvers" and "Get Ticket Approvals" endpoints.
Response Schema Hide
{
"title": "ApprovalsResponse",
"type": "object",
"properties": {
"@odata.context": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Title": {
"type": "string"
},
"AdditionalDetails": {
"type": "string"
},
"IsRequiredByAll": {
"type": "boolean"
},
"ApprovalState": {
"type": "integer"
},
"TVAConversationId": {
"type": "string"
},
"TVAActivityId": {
"type": "string"
},
"HelpbotConversationId": {
"type": [
"string"
]
},
"HelpbotActivityId": {
"type": [
"string"
]
},
"TicketLifecyclePhaseId": {
"type": [
"integer"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": "integer"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/Approvals"
fetch("https://app.tikit.ai/api/Approvals", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/Approvals" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://platformapp-05.azurewebsites.net/api/$metadata#Approvals",
"value": [
{
"Title": "Can Henrietta make an emergency laptop purchase?",
"AdditionalDetails": "",
"IsRequiredByAll": false,
"ApprovalState": 1,
"TVAConversationId": "a:19S_c99j4PAaj6aLG9mpaSHT1n5E3mxuLvHmX4EizMxXG1RtXnC_5ukaxzyCiynYpvEzRnLq-hB_mTF_PnWOChvuDA0bLH2SgZiz5s3sqbzJ7k8BhsKNucmSgfNPn_dRr",
"TVAActivityId": "1720460568827",
"HelpbotConversationId": null,
"HelpbotActivityId": null,
"TicketLifecyclePhaseId": null,
"Id": 2,
"ModifiedDate": "2024-07-08T17:45:00.1723755Z",
"ModifiedById": 5,
"CreatedDate": "2024-07-08T17:42:43.84551Z",
"CreatedById": 4,
"Guid": "41baa0ec-79bc-4e87-b8a8-e5014601d77c",
"IsDeleted": false
},
{
"Title": "please approve software purchase",
"AdditionalDetails": "this is an emergency purchase",
"IsRequiredByAll": false,
"ApprovalState": 1,
"TVAConversationId": "a:19S_c99j4PAaj6aLG9mpaSHT1n5E3mxuLvHmX4EizMxXG1RtXnC_5ukaxzyCiynYpvEzRnLq-hB_mTF_PnWOChvuDA0bLH2SgZiz5s3sqbzJ7k8BhsKNucmSgfNPn_dRr",
"TVAActivityId": "1720536053301",
"HelpbotConversationId": null,
"HelpbotActivityId": null,
"TicketLifecyclePhaseId": null,
"Id": 4,
"ModifiedDate": "2024-07-09T14:41:53.5590955Z",
"ModifiedById": 5,
"CreatedDate": "2024-07-09T14:40:49.6661558Z",
"CreatedById": 4,
"Guid": "6bebad34-93a9-4dd9-9e21-bf83ee6199df",
"IsDeleted": false
},
{
"Title": "Approve New Account",
"AdditionalDetails": "Please Approve",
"IsRequiredByAll": false,
"ApprovalState": 1,
"TVAConversationId": "a:19S_c99j4PAaj6aLG9mpaSHT1n5E3mxuLvHmX4EizMxXG1RtXnC_5ukaxzyCiynYpvEzRnLq-hB_mTF_PnWOChvuDA0bLH2SgZiz5s3sqbzJ7k8BhsKNucmSgfNPn_dRr",
"TVAActivityId": "1722950536612",
"HelpbotConversationId": null,
"HelpbotActivityId": null,
"TicketLifecyclePhaseId": 5,
"Id": 8,
"ModifiedDate": "2024-08-06T13:22:26.8557375Z",
"ModifiedById": 1,
"CreatedDate": "2024-08-06T13:22:11.526255Z",
"CreatedById": null,
"Guid": "7ee0901b-c041-457f-8aee-ba3296a3c1e9",
"IsDeleted": false
}
]
}
GET
https://app.tikit.ai/api/Approvers
Get Approvers
This endpoint, with no filter criteria or any other parameters, will return an array of all approvers and properties. Contains the "ApprovalId" for linking to approvals.
Response Schema Hide
{
"title": "ApproversResponse",
"type": "object",
"properties": {
"@odata.context": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Id": {
"type": "integer"
},
"ApproverId": {
"type": "integer"
},
"HasApproved": {
"type": "integer"
},
"TVAConversationId": {
"type": "string"
},
"TVAActivityId": {
"type": "string"
},
"HelpbotConversationId": {
"type": [
"string"
]
},
"HelpbotActivityId": {
"type": [
"string"
]
},
"IsAddNotificationSent": {
"type": "boolean"
},
"ApprovalId": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": "integer"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": "integer"
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/Approvers"
fetch("https://app.tikit.ai/api/Approvers", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/Approvers" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#Approvers",
"value": [
{
"Id": 1,
"ApproverId": 2,
"HasApproved": 3,
"TVAConversationId": "a:19S_c99j4PAaj6aLG9mpaSHT1n5E3mxuLvHmX4EizMxXG1RtXnC_5ukaxzyCiynYpvEzRnLq-hB_mTF_PnWOChvuDA0bLH2SgZiz5s3sqbzJ7k8BhsKNucmSgfNPn_dRr",
"TVAActivityId": "1720448322809",
"HelpbotConversationId": null,
"HelpbotActivityId": null,
"IsAddNotificationSent": false,
"ApprovalId": 1,
"ModifiedDate": "2024-07-08T14:18:42.9600229Z",
"ModifiedById": 4,
"CreatedDate": "2024-07-08T14:18:38.7294002Z",
"CreatedById": 4,
"Guid": "74ff0b4d-fb36-49dd-b463-df59cfb27380",
"IsDeleted": false
},
{
"Id": 2,
"ApproverId": 5,
"HasApproved": 1,
"TVAConversationId": "a:13-Lks90okM3eu3npvlPHYzoEvFIQAkXP_-VIIFUI8IKNzmGDuRY1oRSmhRD_BoYIFkSbVMXgV7_X9EOEEQ7rZoXOPWFM6vSxAHMu7sXtOVK1vltuOM3MbST8Ebt7llVZ",
"TVAActivityId": "1720460702442",
"HelpbotConversationId": null,
"HelpbotActivityId": null,
"IsAddNotificationSent": false,
"ApprovalId": 2,
"ModifiedDate": "2024-07-08T17:45:02.5968043Z",
"ModifiedById": 5,
"CreatedDate": "2024-07-08T17:42:43.84551Z",
"CreatedById": 4,
"Guid": "284c9ec9-71bc-47cf-9f8c-1210611353e8",
"IsDeleted": false
},
{
"Id": 3,
"ApproverId": 5,
"HasApproved": 1,
"TVAConversationId": "a:13-Lks90okM3eu3npvlPHYzoEvFIQAkXP_-VIIFUI8IKNzmGDuRY1oRSmhRD_BoYIFkSbVMXgV7_X9EOEEQ7rZoXOPWFM6vSxAHMu7sXtOVK1vltuOM3MbST8Ebt7llVZ",
"TVAActivityId": "1720531972301",
"HelpbotConversationId": null,
"HelpbotActivityId": null,
"IsAddNotificationSent": false,
"ApprovalId": 3,
"ModifiedDate": "2024-07-09T13:32:52.4116046Z",
"ModifiedById": 5,
"CreatedDate": "2024-07-09T13:31:01.3376261Z",
"CreatedById": 4,
"Guid": "5a812282-b1be-443a-bddb-c03729b35ba9",
"IsDeleted": false
}
]
}
GET
https://app.tikit.ai/api/LifecycleApproval
Get Lifecycle Approvals
This endpoint, with no filter criteria or any other parameters, will return an array of all lifecycle approvals and properties. Approvers and tickets can be linked to lifecycle approvals via the "Get Approvers" and "Get Ticket Approvals.md" endpoints.
Response Schema Hide
{
"title": "LifecycleApprovalResponse",
"type": "object",
"properties": {
"@odata.context": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"Description": {
"type": [
"string"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": "integer"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": "integer"
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
},
"AdditionalDetails": {
"type": "string"
},
"IsRequiredByAll": {
"type": "boolean"
},
"LifecyclePhaseId": {
"type": "integer"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/LifecycleApproval"
fetch("https://app.tikit.ai/api/LifecycleApproval", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/LifecycleApproval" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#LifecycleApproval",
"value": [
{
"Name": "Approve New User",
"Description": null,
"Id": 11,
"ModifiedDate": "2024-08-06T14:02:52.9140143Z",
"ModifiedById": 1,
"CreatedDate": "2024-08-06T14:02:52.9140143Z",
"CreatedById": 1,
"Guid": "ee0c246c-681a-4efe-b625-f6cab772fb3a",
"IsDeleted": false,
"AdditionalDetails": "Please approve",
"IsRequiredByAll": false,
"LifecyclePhaseId": 10
},
{
"Name": "Approve",
"Description": null,
"Id": 18,
"ModifiedDate": "2025-01-27T19:35:01.796568Z",
"ModifiedById": 1,
"CreatedDate": "2025-01-27T19:35:01.796568Z",
"CreatedById": 1,
"Guid": "d402ad19-146b-42e0-9282-44cd3df74f73",
"IsDeleted": false,
"AdditionalDetails": "",
"IsRequiredByAll": false,
"LifecyclePhaseId": 8
},
{
"Name": "Approve",
"Description": null,
"Id": 20,
"ModifiedDate": "2025-01-27T19:37:30.6558167Z",
"ModifiedById": 1,
"CreatedDate": "2025-01-27T19:37:30.6558167Z",
"CreatedById": 1,
"Guid": "3686080e-7c92-442e-901e-49105f965b0d",
"IsDeleted": false,
"AdditionalDetails": "",
"IsRequiredByAll": false,
"LifecyclePhaseId": 19
}
]
}
GET
https://app.tikit.ai/api/TicketApprovals
Get Ticket Approvals
This endpoint, with no filter criteria or any other parameters, will return an array of all ticket approvals and properties. Contains the "ApprovalId" for linking to approvals.
Response Schema Hide
{
"title": "TicketApprovalsResponse",
"type": "object",
"properties": {
"@odata.context": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Id": {
"type": "integer"
},
"TicketId": {
"type": "integer"
},
"ApprovalId": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/TicketApprovals"
fetch("https://app.tikit.ai/api/TicketApprovals", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/TicketApprovals" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#TicketApprovals",
"value": [
{
"Id": 1,
"TicketId": 14,
"ApprovalId": 1,
"ModifiedDate": "2024-07-08T14:18:38.7294002Z",
"ModifiedById": 4,
"CreatedDate": "2024-07-08T14:18:38.7294002Z",
"CreatedById": 4,
"Guid": "f2554eaa-05d0-4310-a849-e0ae3e90a055",
"IsDeleted": false
},
{
"Id": 6,
"TicketId": 24,
"ApprovalId": 6,
"ModifiedDate": "2024-07-09T16:18:31.2961395Z",
"ModifiedById": 4,
"CreatedDate": "2024-07-09T16:18:31.2961395Z",
"CreatedById": 4,
"Guid": "569a8b63-a588-4371-8996-d244a999d389",
"IsDeleted": false
},
{
"Id": 7,
"TicketId": 25,
"ApprovalId": 7,
"ModifiedDate": "2024-08-06T12:59:25.3198049Z",
"ModifiedById": null,
"CreatedDate": "2024-08-06T12:59:25.3198049Z",
"CreatedById": null,
"Guid": "d4791dd0-44be-4f96-a485-892329751bd9",
"IsDeleted": false
}
]
}
Automations
GET
https://app.tikit.ai/api/Phase
Get Automations
This endpoint, with no filter criteria or any other parameters, will return an array of all automations and properties.
Response Schema Hide
{
"type": "object",
"properties": {
"@odata.context": {
"type": "string",
"format": "uri"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Title": {
"type": "string"
},
"Description": {
"type": "string"
},
"InputJson": {
"type": "string"
},
"ResultsJson": {
"type": "string"
},
"Status": {
"type": "string"
},
"TriggerId": {
"type": "integer"
},
"Enabled": {
"type": "boolean"
},
"IsSystem": {
"type": "boolean"
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/Phase"
fetch("https://app.tikit.ai/api/Phase", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/Phase" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#Phase",
"value": [
{
"Title": "Auto close tickets resolved for 3 days or more days",
"Description": "Automatically close tickets if they have been resolved for 3 or more days",
"InputJson": "{}",
"ResultsJson": "{}",
"Status": "Success",
"TriggerId": 3,
"Enabled": false,
"IsSystem": false,
"Id": 1,
"ModifiedDate": "2025-02-13T15:11:20.0111746Z",
"ModifiedById": 1,
"CreatedDate": "2023-04-04T03:48:55.0048735Z",
"CreatedById": null,
"Guid": "9b3dafac-5adf-4d73-ba7c-04267bd722d5",
"IsDeleted": false
},
{
"Title": "Set resolution date upon resolving ticket",
"Description": "Set resolution date to the moment it is resolved",
"InputJson": "{}",
"ResultsJson": "{}",
"Status": "Success",
"TriggerId": 2,
"Enabled": true,
"IsSystem": false,
"Id": 2,
"ModifiedDate": "2025-05-06T15:13:42.6787347Z",
"ModifiedById": 1,
"CreatedDate": "2023-04-04T03:48:55.9859491Z",
"CreatedById": null,
"Guid": "0d082ead-e985-4a20-8529-4a5bd2292e47",
"IsDeleted": false
},
{
"Title": "@Mentions",
"Description": "When an agent is @mentioned, they will be notified in Teams and Email",
"InputJson": "{}",
"ResultsJson": "{}",
"Status": "Success",
"TriggerId": 2,
"Enabled": true,
"IsSystem": false,
"Id": 3,
"ModifiedDate": "2025-06-03T19:11:39.9317681Z",
"ModifiedById": null,
"CreatedDate": "2024-09-19T02:29:27.7246518Z",
"CreatedById": null,
"Guid": "33b18510-b38e-460b-98c3-cc76d5e1a6e1",
"IsDeleted": false
},
{
"Title": "Tagged - VIP",
"Description": "Set High Priority and add Collaborators",
"InputJson": "{}",
"ResultsJson": "{}",
"Status": "Success",
"TriggerId": 2,
"Enabled": true,
"IsSystem": false,
"Id": 4,
"ModifiedDate": "2025-05-26T18:29:16.8488154Z",
"ModifiedById": 1,
"CreatedDate": "2025-04-09T17:58:43.7575686Z",
"CreatedById": 1,
"Guid": "210cb185-0a7f-42d0-b8b6-2f1c8577d470",
"IsDeleted": false
}
]
}
Comments
GET
https://app.tikit.ai/api/Comment
Get Comments
This endpoint, with no filter criteria or any other parameters, will return an array of ticket comments and properties.
Response Schema Hide
{
"type": "object",
"properties": {
"@odata.context": {
"type": "string",
"format": "uri"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
},
"Body": {
"type": "string"
},
"IsPublic": {
"type": "boolean"
},
"LinkToMessage": {
"type": [
"string"
]
},
"TicketId": {
"type": "integer"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/Comment"
fetch("https://app.tikit.ai/api/Comment", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/Comment" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#Comment",
"value": [
{
"Id": 14,
"ModifiedDate": "2024-10-08T16:28:19.0545563Z",
"ModifiedById": 7,
"CreatedDate": "2024-10-08T16:28:19.0545563Z",
"CreatedById": 7,
"Guid": "057cab6f-4535-4f91-93d9-58415458d80f",
"IsDeleted": false,
"Body": "This is just the text that should be displayed in the comments",
"IsPublic": true,
"LinkToMessage": null,
"TicketId": 43
},
{
"Id": 19,
"ModifiedDate": "2024-10-16T12:45:50.0282683Z",
"ModifiedById": 1,
"CreatedDate": "2024-10-16T12:45:50.0282683Z",
"CreatedById": 1,
"Guid": "8f23dfeb-7ce2-4ac0-88dc-1512e3625530",
"IsDeleted": false,
"Body": "We are working on this",
"IsPublic": true,
"LinkToMessage": null,
"TicketId": 46
},
{
"Id": 47,
"ModifiedDate": "2025-04-09T12:53:31.428981Z",
"ModifiedById": 7,
"CreatedDate": "2025-04-09T12:53:31.428981Z",
"CreatedById": 7,
"Guid": "8df4c9d6-b414-4de3-8dfd-c463d46eb10e",
"IsDeleted": false,
"Body": "A picture:\r\n\r\n
POST
https://app.tikit.ai/api/Comment
Create Comment
This endpoint is used to create a comment for ticket by ticket Id. The comment properties should be passed as the JSON body payload.
-
-
-
Parameters
-
Body(string, required) - The text of the comment
-
TicketId(integer, required) - The Id of the ticket this comment should be added to
-
IsPublic(boolean, optional) - If the comment is public or internal
Response Schema Hide
{
"type": "object",
"properties": {
"@odata.context": {
"type": "string",
"format": "uri"
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
},
"Body": {
"type": "string"
},
"IsPublic": {
"type": "boolean"
},
"LinkToMessage": {
"type": [
"string"
]
},
"TicketId": {
"type": "integer"
}
}
}
Code Samples
curl -X POST -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/Comment"
fetch("https://app.tikit.ai/api/Comment", { method: "POST", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/Comment" -Method POST -Headers @{Authorization = "Bearer <token>"}Request Example
{
"Body": "Try rebooting!",
"TicketId": 101,
"IsPublic": true
}
Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#Comment/$entity",
"Id": 53,
"ModifiedDate": "2025-06-03T19:11:37.3543513Z",
"ModifiedById": 1,
"CreatedDate": "2025-06-03T19:11:37.3543513Z",
"CreatedById": 1,
"Guid": "f2d83939-342c-4682-9173-b35b21b97407",
"IsDeleted": false,
"Body": "Try rebooting!",
"IsPublic": true,
"LinkToMessage": null,
"TicketId": 101
}
FileAttachments
GET
https://app.tikit.ai/api/FileAttachment
Get File Attachments
This endpoint, with no filter criteria or any other parameters, will return an array of all ticket file attachments and properties.
Response Schema Hide
{
"title": "FileAttachmentResponse",
"type": "object",
"properties": {
"@odata.context": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"FileName": {
"type": "string"
},
"MediaType": {
"type": [
"string"
]
},
"FileSize": {
"type": "number"
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": "integer"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": "integer"
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
},
"DownladUrl": {
"type": "string"
},
"ContentUrl": {
"type": [
"string"
]
},
"DriveItemGroupId": {
"type": "string"
},
"DriveItemId": {
"type": "string"
},
"MoveItemFailed": {
"type": "boolean"
},
"TicketId": {
"type": "integer"
},
"FileCommentId": {
"type": "integer"
},
"IsPublic": {
"type": "boolean"
},
"ThumbnailUrl": {
"type": "string"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/FileAttachment"
fetch("https://app.tikit.ai/api/FileAttachment", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/FileAttachment" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://platformapp-07.azurewebsites.net/api/$metadata#FileAttachment",
"value": [
{
"FileName": "Outlook-bipuuzad.png",
"MediaType": "EmailInlineImage",
"FileSize": 29015.0,
"Id": 2,
"ModifiedDate": "2024-10-08T16:29:32.2194624Z",
"ModifiedById": 7,
"CreatedDate": "2024-10-08T16:29:32.2194624Z",
"CreatedById": 7,
"Guid": "ccb1b036-f43b-4265-b76d-e61e671273ed",
"IsDeleted": false,
"DownladUrl": "https://6pjybx.sharepoint.com/:i:/s/Support/EdXuc-T_NhZCtckXCx6y6k4B9E9mGdHY782tgwM7fhAbDg",
"ContentUrl": "cid:83bb2566-1e35-4455-95a5-bc82a30cce1d",
"DriveItemGroupId": "507f85f3-a432-4341-9929-7b0d891e8c42",
"DriveItemId": "016ZBJE56V5ZZ6J7ZWCZBLLSIXBMPLF2SO",
"MoveItemFailed": false,
"TicketId": 44,
"FileCommentId": 15,
"IsPublic": true,
"ThumbnailUrl": "https://eastus1-mediap.svc.ms/transform/thumbnail?provider=spo&inputFormat=png&cs=YjEzYzQwZWUtZTA3My00NTllLTk2YjUtM2YzY2NhMDQ2YTM3fFNQTw&docid=https%3A%2F%2F6pjybx.sharepoint.com%2F_api%2Fv2.0%2Fdrives%2Fb!tR_3A2MBBU6l_9IcJ8zuVbhlA5hTtfpHu130MNcqwgc2pTuHMyA_Q6ZEA7mbkajU%2Fitems%2F016ZBJE56V5ZZ6J7ZWCZBLLSIXBMPLF2SO%3Ftempauth%3Dv1.eyJzaXRlaWQiOiIwM2Y3MWZiNS0wMTYzLTRlMDUtYTVmZi1kMjFjMjdjY2VlNTUiLCJhcHBfZGlzcGxheW5hbWUiOiJUaWtpdCIsImF1ZCI6IjAwMDAwMDAzLTAwMDAtMGZmMS1jZTAwLTAwMDAwMDAwMDAwMC82cGp5Ynguc2hhcmVwb2ludC5jb21AN2Y2NTIyMjUtNTMxMy00YzA0LWI3NzctOTJhNzhiNjdkODE5IiwiZXhwIjoiMTcyODQyMTIwMCJ9.CgoKBHNuaWQSAjg0EgYI3s06EAEaDTIwLjE5MC4xNTEuMzgqLERVUWl1QTJMdUNkMFpoL3MwbVdXRytPUFVBU3ZiVWgzdTJ4Ni85VUU5bWc9MJoBOAFKEGhhc2hlZHByb29mdG9rZW56ATG6ATlncm91cC5yZWFkIGFsbHNpdGVzLndyaXRlIGFsbGZpbGVzLndyaXRlIGFsbHByb2ZpbGVzLnJlYWTCAUliMTNjNDBlZS1lMDczLTQ1OWUtOTZiNS0zZjNjY2EwNDZhMzdAN2Y2NTIyMjUtNTMxMy00YzA0LWI3NzctOTJhNzhiNjdkODE5.zjPx-dzMMIPzhxgi5HtajHtYgV0FfXlcKSt7aIXjNgc%26version%3DPublished&width=800&height=800&cb=63864001766"
},
{
"FileName": "Outlook-wlh3xhki.jpg",
"MediaType": "EmailInlineImage",
"FileSize": 39441.0,
"Id": 3,
"ModifiedDate": "2024-10-08T16:29:32.2194624Z",
"ModifiedById": 7,
"CreatedDate": "2024-10-08T16:29:32.2194624Z",
"CreatedById": 7,
"Guid": "6ef36e98-e044-4f28-a677-d235b8d4b448",
"IsDeleted": false,
"DownladUrl": "https://6pjybx.sharepoint.com/:i:/s/Support/EZgagKh1DgxLo3zraXiXZbIB0STkrQXMrvWasX1GI64J9Q",
"ContentUrl": "cid:6f12135f-fb40-42b9-8274-c6214e5347c5",
"DriveItemGroupId": "507f85f3-a432-4341-9929-7b0d891e8c42",
"DriveItemId": "016ZBJE54YDKAKQ5IOBRF2G7HLNF4JOZNS",
"MoveItemFailed": false,
"TicketId": 44,
"FileCommentId": 15,
"IsPublic": true,
"ThumbnailUrl": "https://eastus1-mediap.svc.ms/transform/thumbnail?provider=spo&inputFormat=jpg&cs=YjEzYzQwZWUtZTA3My00NTllLTk2YjUtM2YzY2NhMDQ2YTM3fFNQTw&docid=https%3A%2F%2F6pjybx.sharepoint.com%2F_api%2Fv2.0%2Fdrives%2Fb!tR_3A2MBBU6l_9IcJ8zuVbhlA5hTtfpHu130MNcqwgc2pTuHMyA_Q6ZEA7mbkajU%2Fitems%2F016ZBJE54YDKAKQ5IOBRF2G7HLNF4JOZNS%3Ftempauth%3Dv1.eyJzaXRlaWQiOiIwM2Y3MWZiNS0wMTYzLTRlMDUtYTVmZi1kMjFjMjdjY2VlNTUiLCJhcHBfZGlzcGxheW5hbWUiOiJUaWtpdCIsImF1ZCI6IjAwMDAwMDAzLTAwMDAtMGZmMS1jZTAwLTAwMDAwMDAwMDAwMC82cGp5Ynguc2hhcmVwb2ludC5jb21AN2Y2NTIyMjUtNTMxMy00YzA0LWI3NzctOTJhNzhiNjdkODE5IiwiZXhwIjoiMTcyODQyMTIwMCJ9.CgoKBHNuaWQSAjg0EgYI3s06EAEaDTIwLjE5MC4xNTEuMzgqLERlVm9uSnMxQWJxcERDZCtCOFpWOGxZMU9KVzJ5YkNmS24rNGd2S2JBQ3M9MJoBOAFKEGhhc2hlZHByb29mdG9rZW56ATG6ATlncm91cC5yZWFkIGFsbHNpdGVzLndyaXRlIGFsbGZpbGVzLndyaXRlIGFsbHByb2ZpbGVzLnJlYWTCAUliMTNjNDBlZS1lMDczLTQ1OWUtOTZiNS0zZjNjY2EwNDZhMzdAN2Y2NTIyMjUtNTMxMy00YzA0LWI3NzctOTJhNzhiNjdkODE5.PfKuuCVxWOZ7sZNPHxOAgM9ajRLc5EWKTtieqbEtk48%26version%3DPublished&width=800&height=800&cb=63864001770"
},
{
"FileName": "cireson.png",
"MediaType": null,
"FileSize": 9339.0,
"Id": 4,
"ModifiedDate": "2024-10-29T15:27:08.3525739Z",
"ModifiedById": 1,
"CreatedDate": "2024-10-29T15:27:08.3525739Z",
"CreatedById": 1,
"Guid": "3284066d-a155-4d27-bb1b-e6ecce5411c3",
"IsDeleted": false,
"DownladUrl": "https://6pjybx.sharepoint.com/:i:/s/Support/EXks6Ya8nHdKpUzvEl85GzQB2yDOvga5RshoapbJtUEUtg",
"ContentUrl": null,
"DriveItemGroupId": "507f85f3-a432-4341-9929-7b0d891e8c42",
"DriveItemId": "016ZBJE53ZFTUYNPE4O5FKKTHPCJPTSGZU",
"MoveItemFailed": false,
"TicketId": 40,
"FileCommentId": 20,
"IsPublic": true,
"ThumbnailUrl": "https://southcentralus1-mediap.svc.ms/transform/thumbnail?provider=spo&inputFormat=png&cs=YjEzYzQwZWUtZTA3My00NTllLTk2YjUtM2YzY2NhMDQ2YTM3fFNQTw&docid=https%3A%2F%2F6pjybx.sharepoint.com%2F_api%2Fv2.0%2Fdrives%2Fb!tR_3A2MBBU6l_9IcJ8zuVbhlA5hTtfpHu130MNcqwgc2pTuHMyA_Q6ZEA7mbkajU%2Fitems%2F016ZBJE53ZFTUYNPE4O5FKKTHPCJPTSGZU%3Ftempauth%3Dv1.eyJzaXRlaWQiOiIwM2Y3MWZiNS0wMTYzLTRlMDUtYTVmZi1kMjFjMjdjY2VlNTUiLCJhcHBfZGlzcGxheW5hbWUiOiJUaWtpdCIsImF1ZCI6IjAwMDAwMDAzLTAwMDAtMGZmMS1jZTAwLTAwMDAwMDAwMDAwMC82cGp5Ynguc2hhcmVwb2ludC5jb21AN2Y2NTIyMjUtNTMxMy00YzA0LWI3NzctOTJhNzhiNjdkODE5IiwiZXhwIjoiMTczMDIzNTYwMCJ9.CgoKBHNuaWQSAjg0EgYIztU6EAEaDDQwLjEyNi4yMy4zOCosaW5wUXBPbHlDTUp0WjZCR3hFSmFNbHR0OVFNTFErWWkvMXhpcVc3S2xrMD0wmgE4AUoQaGFzaGVkcHJvb2Z0b2tlbnoBMboBOWdyb3VwLnJlYWQgYWxsc2l0ZXMud3JpdGUgYWxsZmlsZXMud3JpdGUgYWxscHJvZmlsZXMucmVhZMIBSWIxM2M0MGVlLWUwNzMtNDU5ZS05NmI1LTNmM2NjYTA0NmEzN0A3ZjY1MjIyNS01MzEzLTRjMDQtYjc3Ny05MmE3OGI2N2Q4MTk.h7XlocY5PhCk27HR7OYT6isyuzC7xBIFr_ikc4bym7Q%26version%3DPublished&width=800&height=800&cb=63865812425"
}
]
}
Groups
GET
https://app.tikit.ai/api/SupportGroup
Get Groups
This endpoint, with no filter criteria or any other parameters, will return an array of all groups and properties.
Response Schema Hide
{
"title": "SupportGroupResponse",
"type": "object",
"properties": {
"@odata.context": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": "integer"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": "integer"
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
},
"Name": {
"type": "string"
},
"Description": {
"type": "string"
},
"TeamsChannelId": {
"type": "string"
},
"TeamsAadObjectId": {
"type": "string"
},
"ApplicationRoleId": {
"type": [
"integer"
]
},
"IsArchived": {
"type": "boolean"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/SupportGroup"
fetch("https://app.tikit.ai/api/SupportGroup", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/SupportGroup" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#SupportGroup",
"value": [
{
"Id": 1,
"ModifiedDate": "2024-07-05T20:06:15.115808Z",
"ModifiedById": 1,
"CreatedDate": "2024-05-15T19:53:36.4207335Z",
"CreatedById": 1,
"Guid": "6048450a-f75f-43a5-b58b-f7925a45b56c",
"IsDeleted": false,
"Name": "🎟️ Service Desk",
"Description": "Tech Support",
"TeamsChannelId": "19:c6bea6a2cbba4488a58e8a379f33b489@thread.tacv2",
"TeamsAadObjectId": "507f85f3-a432-4341-9929-7b0d891e8c42",
"ApplicationRoleId": null,
"IsArchived": false
},
{
"Id": 2,
"ModifiedDate": "2024-09-09T19:29:29.1527979Z",
"ModifiedById": 1,
"CreatedDate": "2024-07-05T20:07:10.5409113Z",
"CreatedById": 1,
"Guid": "9851a0e8-3e9d-4b4e-967f-cdaf65b48863",
"IsDeleted": false,
"Name": "💿 Licensing Support",
"Description": "Software Licensing for the Org",
"TeamsChannelId": "19:b937ab0870db40fda3c1dc9535e8f169@thread.tacv2",
"TeamsAadObjectId": "507f85f3-a432-4341-9929-7b0d891e8c42",
"ApplicationRoleId": 5,
"IsArchived": false
},
{
"Id": 3,
"ModifiedDate": "2024-09-09T19:31:40.8936684Z",
"ModifiedById": 1,
"CreatedDate": "2024-09-09T19:31:21.5925383Z",
"CreatedById": 1,
"Guid": "c38e9e91-4e85-4c55-acf8-07247de1b98f",
"IsDeleted": false,
"Name": "Networking Support",
"Description": "",
"TeamsChannelId": "19:3141c24970544da8a7c8add9ab0a5e62@thread.tacv2",
"TeamsAadObjectId": "507f85f3-a432-4341-9929-7b0d891e8c42",
"ApplicationRoleId": 5,
"IsArchived": true
}
]
}
POST
https://app.tikit.ai/api/SupportGroup
Create Group
This endpoint is used to create a new group in Tikit. The team properties should be passed as the JSON body payload.
-
-
-
Parameters
-
Name(string, required) - The friendly name of the group
-
TeamsChannelId(string, required) - The Microsoft Teams channel Id this group will be associated with
-
TeamsAadObjectId(string, required) - The Entra Id of the Team where the channel/group resides
Response Schema Hide
{
"title": "SupportGroupEntity",
"type": "object",
"properties": {
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": "integer"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": "integer"
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
},
"Name": {
"type": "string"
},
"Description": {
"type": [
"string"
]
},
"TeamsChannelId": {
"type": "string"
},
"TeamsAadObjectId": {
"type": "string",
"format": "uuid"
},
"ApplicationRoleId": {
"type": [
"integer"
]
},
"IsArchived": {
"type": "boolean"
}
}
}
Code Samples
curl -X POST -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/SupportGroup"
fetch("https://app.tikit.ai/api/SupportGroup", { method: "POST", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/SupportGroup" -Method POST -Headers @{Authorization = "Bearer <token>"}Request Example
{
"Name": "Sales West",
"TeamsChannelId": "19:32acc79af2284780ab37bea2a4dd835f@thread.tacv2",
"TeamsAadObjectId": "7a3fd66c-9e4a-4d79-838a-b46ac9897e3a"
}
Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#SupportGroup/$entity",
"Id": 5,
"ModifiedDate": "2025-06-19T19:32:20.8338476Z",
"ModifiedById": 1,
"CreatedDate": "2025-06-19T19:32:20.8338476Z",
"CreatedById": 1,
"Guid": "5875e189-1263-474d-8ea0-52ed1b5d859b",
"IsDeleted": false,
"Name": "Sales West",
"Description": null,
"TeamsChannelId": "19:32acc79af2284780ab37bea2a4dd835f@thread.tacv2",
"TeamsAadObjectId": "7a3fd66c-9e4a-4d79-838a-b46ac9897e3a",
"ApplicationRoleId": null,
"IsArchived": false
}
KBs
A collection of endpoints for managing the Tikit KB.
GET
https://app.tikit.ai/api/KnowledgeAnswer
Get Knowledge Answers
This endpoint, with no filter criteria or any other parameters, will return an array of all knowledge answers and properties.
Response Schema Hide
{
"title": "KnowledgeAnswerResponse",
"type": "object",
"properties": {
"@odata.context": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Answer": {
"type": "string"
},
"Source": {
"type": "string"
},
"KnowledgeArticleStatus": {
"type": "string"
},
"AgentOnly": {
"type": "boolean"
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/KnowledgeAnswer"
fetch("https://app.tikit.ai/api/KnowledgeAnswer", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/KnowledgeAnswer" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://platformapp-07.azurewebsites.net/api/$metadata#KnowledgeAnswer",
"value": [
{
"Answer": "ExecuteCommand:MyTickets",
"Source": "HelpBot",
"KnowledgeArticleStatus": "Active",
"AgentOnly": false,
"Id": 1,
"ModifiedDate": "2024-08-15T02:22:39.1190284Z",
"ModifiedById": null,
"CreatedDate": "2024-08-15T02:22:39.1190284Z",
"CreatedById": null,
"Guid": "95f0f01f-d4ef-4a4b-a4ac-47425cc03a4d",
"IsDeleted": false
},
{
"Answer": "Here is an image:\n\n\n\n \n\n",
"Source": "Editorial",
"KnowledgeArticleStatus": "Active",
"AgentOnly": false,
"Id": 27,
"ModifiedDate": "2025-06-02T16:49:54.8182028Z",
"ModifiedById": 1,
"CreatedDate": "2025-06-02T16:49:54.8182028Z",
"CreatedById": 1,
"Guid": "a534d41c-5dc3-4e92-ab39-fd21e155a588",
"IsDeleted": false
},
{
"Answer": "ApplyTemplate:7",
"Source": "Template",
"KnowledgeArticleStatus": "Active",
"AgentOnly": false,
"Id": 28,
"ModifiedDate": "2025-06-05T14:36:54.4997153Z",
"ModifiedById": 1,
"CreatedDate": "2025-06-05T14:36:54.4997153Z",
"CreatedById": 1,
"Guid": "b9f7ef78-6624-4e0f-8fad-ac5be28b6b0d",
"IsDeleted": false
}
]
}
Lifecycles
GET
https://app.tikit.ai/api/LifecyclePhase
Get Lifecycle Phases
This endpoint, with no filter criteria or any other parameters, will return an array of all lifecycle phases and properties.
Response Schema Hide
{
"title": "LifecyclePhaseResponse",
"type": "object",
"properties": {
"@odata.context": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"Description": {
"type": [
"string"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": "integer"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": "integer"
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
},
"Order": {
"type": "integer"
},
"LifecycleId": {
"type": "integer"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/LifecyclePhase"
fetch("https://app.tikit.ai/api/LifecyclePhase", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/LifecyclePhase" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#LifecyclePhase",
"value": [
{
"Name": "Update Ticket",
"Description": null,
"Id": 8,
"ModifiedDate": "2024-08-06T14:02:51.9305889Z",
"ModifiedById": 1,
"CreatedDate": "2024-08-06T14:02:51.9305889Z",
"CreatedById": 1,
"Guid": "12a1e6b7-6acf-436b-83c1-a083332a9716",
"IsDeleted": false,
"Order": 0,
"LifecycleId": 1
},
{
"Name": "Get Approval",
"Description": null,
"Id": 10,
"ModifiedDate": "2024-08-06T14:02:52.6910713Z",
"ModifiedById": 1,
"CreatedDate": "2024-08-06T14:02:52.6910713Z",
"CreatedById": 1,
"Guid": "57ad4005-b367-4045-a300-660455d4e49b",
"IsDeleted": false,
"Order": 1,
"LifecycleId": 1
},
{
"Name": "Create Entra Account",
"Description": null,
"Id": 13,
"ModifiedDate": "2024-08-06T14:02:53.5646823Z",
"ModifiedById": 1,
"CreatedDate": "2024-08-06T14:02:53.5646823Z",
"CreatedById": 1,
"Guid": "fe5b4f78-6f9b-4138-b049-a6ca86fa9a1c",
"IsDeleted": false,
"Order": 2,
"LifecycleId": 1
}
]
}
GET
https://app.tikit.ai/api/LifeCycle
Get Lifecycles
This endpoint, with no filter criteria or any other parameters, will return an array of all lifecycles and properties.
Response Schema Hide
{
"title": "LifeCycleResponse",
"type": "object",
"properties": {
"@odata.context": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Title": {
"type": "string"
},
"Description": {
"type": "string"
},
"IsArchived": {
"type": "boolean"
},
"SetStatusResolved": {
"type": "boolean"
},
"ResolutionNote": {
"type": [
"string"
]
},
"ResolutionNoteInternal": {
"type": [
"string"
]
},
"ResolutionCategoryId": {
"type": [
"integer"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": "integer"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": "integer"
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/LifeCycle"
fetch("https://app.tikit.ai/api/LifeCycle", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/LifeCycle" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#LifeCycle",
"value": [
{
"Title": "Onboarding",
"Description": "For new employees",
"IsArchived": false,
"SetStatusResolved": true,
"ResolutionNote": null,
"ResolutionNoteInternal": null,
"ResolutionCategoryId": null,
"Id": 1,
"ModifiedDate": "2024-08-06T12:45:31.7601798Z",
"ModifiedById": 1,
"CreatedDate": "2024-07-05T18:39:23.0119752Z",
"CreatedById": 1,
"Guid": "905a81b2-2f59-4b98-bb71-e1ba36182281",
"IsDeleted": false
},
{
"Title": "Emergency Change Request",
"Description": "Emergency CR Process",
"IsArchived": false,
"SetStatusResolved": false,
"ResolutionNote": null,
"ResolutionNoteInternal": null,
"ResolutionCategoryId": null,
"Id": 2,
"ModifiedDate": "2025-06-19T13:56:53.1060518Z",
"ModifiedById": 1,
"CreatedDate": "2025-01-27T19:37:29.61344Z",
"CreatedById": 1,
"Guid": "e3edefb8-20b9-4aa8-ac6e-6c441f3c9b76",
"IsDeleted": false
},
{
"Title": "Create MS Team",
"Description": "",
"IsArchived": true,
"SetStatusResolved": true,
"ResolutionNote": "resolved",
"ResolutionNoteInternal": "",
"ResolutionCategoryId": 47,
"Id": 3,
"ModifiedDate": "2025-06-05T18:42:55.7538543Z",
"ModifiedById": 1,
"CreatedDate": "2025-06-05T14:27:49.7462556Z",
"CreatedById": 1,
"Guid": "ea42bb72-876c-4061-a347-62f76259531f",
"IsDeleted": false
}
]
}
GET
https://app.tikit.ai/api/TicketLifecycleTransition
Get Ticket Lifecycle Transitions
This endpoint, with no filter criteria or any other parameters, will return an array of all lifecycle transitions and properties. Use the ticket lifecycle Transition property "TicketLifecyclePhaseId" to link to a lifecycle phase "Id".
Response Schema Hide
{
"title": "TicketLifecycleTransitionResponse",
"type": "object",
"properties": {
"@odata.context": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Title": {
"type": "string"
},
"Message": {
"type": "string"
},
"UseDefaultLogic": {
"type": "boolean"
},
"TransitionRuleId": {
"type": "integer"
},
"TransitionActionId": {
"type": "integer"
},
"TicketLifecyclePhaseId": {
"type": "integer"
},
"Order": {
"type": "integer"
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/TicketLifecycleTransition"
fetch("https://app.tikit.ai/api/TicketLifecycleTransition", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/TicketLifecycleTransition" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://platformapp-06.azurewebsites.net/api/$metadata#TicketLifecycleTransition",
"value": [
{
"Title": "Add to Support Team",
"Message": "",
"UseDefaultLogic": true,
"TransitionRuleId": 67,
"TransitionActionId": 67,
"TicketLifecyclePhaseId": 67,
"Order": 0,
"Id": 67,
"ModifiedDate": "2025-06-05T14:23:41.582673Z",
"ModifiedById": null,
"CreatedDate": "2025-06-05T14:23:41.536873Z",
"CreatedById": null,
"Guid": "cba26d0d-2b5e-40f1-80e8-9e9c97898cdb",
"IsDeleted": false
},
{
"Title": "Finish",
"Message": "Jump to end",
"UseDefaultLogic": false,
"TransitionRuleId": 68,
"TransitionActionId": 68,
"TicketLifecyclePhaseId": 68,
"Order": 0,
"Id": 68,
"ModifiedDate": "2025-06-05T14:23:41.6550953Z",
"ModifiedById": null,
"CreatedDate": "2025-06-05T14:23:41.5941886Z",
"CreatedById": null,
"Guid": "40c8f261-b267-4755-8081-9cd15318bd05",
"IsDeleted": false
},
{
"Title": "New Transition 1",
"Message": "",
"UseDefaultLogic": true,
"TransitionRuleId": 69,
"TransitionActionId": 69,
"TicketLifecyclePhaseId": 69,
"Order": 0,
"Id": 69,
"ModifiedDate": "2025-06-05T14:39:12.2629865Z",
"ModifiedById": null,
"CreatedDate": "2025-06-05T14:39:12.2164334Z",
"CreatedById": null,
"Guid": "5441a1d2-d7b2-4ab9-8af4-7926ae892071",
"IsDeleted": false
}
]
}
GET
https://app.tikit.ai/api/TicketLifecycle
Get Ticket Lifecycles
This endpoint, with no filter criteria or any other parameters, will return an array of all ticket lifecycles and properties. Use the ticket lifecycle property "LifecycleId" to link to a lifecycle "Id".
Response Schema Hide
{
"title": "TicketLifecycleResponse",
"type": "object",
"properties": {
"@odata.context": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Title": {
"type": "string"
},
"SetStatusResolved": {
"type": "boolean"
},
"StatusId": {
"type": "integer"
},
"LifecycleId": {
"type": "integer"
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": "integer"
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/TicketLifecycle"
fetch("https://app.tikit.ai/api/TicketLifecycle", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/TicketLifecycle" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://platformapp-07.azurewebsites.net/api/$metadata#TicketLifecycle",
"value": [
{
"Title": "Emergency Change Request",
"SetStatusResolved": true,
"StatusId": 37,
"LifecycleId": 1,
"Id": 1,
"ModifiedDate": "2024-07-05T18:49:40.4030412Z",
"ModifiedById": null,
"CreatedDate": "2024-07-05T18:48:26.7886246Z",
"CreatedById": 5,
"Guid": "fd2e0876-099d-478f-b96a-6053ad74b086",
"IsDeleted": false
},
{
"Title": "New Employee",
"SetStatusResolved": true,
"StatusId": 37,
"LifecycleId": 1,
"Id": 2,
"ModifiedDate": "2025-02-20T17:35:09.3030325Z",
"ModifiedById": 1,
"CreatedDate": "2024-07-08T14:11:49.9034169Z",
"CreatedById": 4,
"Guid": "f11cae32-523b-4216-9d0f-ba093c83043a",
"IsDeleted": false
},
{
"Title": "Purchase Device",
"SetStatusResolved": true,
"StatusId": 36,
"LifecycleId": 1,
"Id": 3,
"ModifiedDate": "2024-08-06T13:01:04.0418755Z",
"ModifiedById": null,
"CreatedDate": "2024-08-06T12:59:18.9044561Z",
"CreatedById": 2,
"Guid": "13858f54-7005-42d4-8b9e-5c57cdd869bc",
"IsDeleted": false
}
]
}
Lists
GET
https://app.tikit.ai/api/Category
Get Category Values
This endpoint, with no filter criteria or any other parameters, will return an array of categories and properties.
Response Schema Hide
{
"type": "object",
"properties": {
"@odata.context": {
"type": "string",
"format": "uri"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Value": {
"type": "string"
},
"Position": {
"type": "integer"
},
"IsArchived": {
"type": "boolean"
},
"IsDefault": {
"type": "boolean"
},
"IsSystem": {
"type": "boolean"
},
"ParentId": {
"type": [
"integer"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/Category"
fetch("https://app.tikit.ai/api/Category", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/Category" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#Category",
"value": [
{
"Value": "Networking",
"Position": 0,
"IsArchived": false,
"IsDefault": false,
"IsSystem": false,
"ParentId": null,
"Id": 1,
"ModifiedDate": "2020-12-22T22:18:11.1849388Z",
"ModifiedById": null,
"CreatedDate": "2020-12-22T22:18:11.1849388Z",
"CreatedById": null,
"Guid": "7cce9641-af06-4954-903b-d36f19af1d2f",
"IsDeleted": false
},
{
"Value": "Onboarding",
"Position": 0,
"IsArchived": false,
"IsDefault": false,
"IsSystem": false,
"ParentId": null,
"Id": 2,
"ModifiedDate": "2020-12-22T22:18:11.1849388Z",
"ModifiedById": null,
"CreatedDate": "2020-12-22T22:18:11.1849388Z",
"CreatedById": null,
"Guid": "fe335553-7258-497f-9e2b-abc21fb1b024",
"IsDeleted": false
},
{
"Value": "Permissions",
"Position": 0,
"IsArchived": false,
"IsDefault": false,
"IsSystem": false,
"ParentId": null,
"Id": 3,
"ModifiedDate": "2020-12-22T22:18:11.1849388Z",
"ModifiedById": null,
"CreatedDate": "2020-12-22T22:18:11.1849388Z",
"CreatedById": null,
"Guid": "cc5fcdaf-d77f-4b02-808d-1babdf99e9a8",
"IsDeleted": false
},
{
"Value": "Printing",
"Position": 0,
"IsArchived": false,
"IsDefault": false,
"IsSystem": false,
"ParentId": null,
"Id": 4,
"ModifiedDate": "2020-12-22T22:18:11.1849388Z",
"ModifiedById": null,
"CreatedDate": "2020-12-22T22:18:11.1849388Z",
"CreatedById": null,
"Guid": "ed63c701-1255-44c2-8824-f8a959825973",
"IsDeleted": false
},
{
"Value": "Software",
"Position": 0,
"IsArchived": false,
"IsDefault": true,
"IsSystem": false,
"ParentId": null,
"Id": 5,
"ModifiedDate": "2020-12-22T22:18:11.1849388Z",
"ModifiedById": null,
"CreatedDate": "2020-12-22T22:18:11.1849388Z",
"CreatedById": null,
"Guid": "eeeedfbc-6a4f-4a8a-bf25-09939577397e",
"IsDeleted": false
}
]
}
GET
https://app.tikit.ai/api/Priority
Get Priority Values
This endpoint, with no filter criteria or any other parameters, will return an array of all priorities and properties.
Response Schema Hide
{
"type": "object",
"properties": {
"@odata.context": {
"type": "string",
"format": "uri"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Value": {
"type": "string"
},
"Position": {
"type": "integer"
},
"IsArchived": {
"type": "boolean"
},
"IsDefault": {
"type": "boolean"
},
"IsSystem": {
"type": "boolean"
},
"ParentId": {
"type": [
"integer"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/Priority"
fetch("https://app.tikit.ai/api/Priority", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/Priority" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#Priority",
"value": [
{
"Value": "1 (High)",
"Position": 0,
"IsArchived": false,
"IsDefault": false,
"IsSystem": false,
"ParentId": null,
"Id": 11,
"ModifiedDate": "2024-09-06T18:55:41.2543411Z",
"ModifiedById": 1,
"CreatedDate": "2020-12-22T22:18:11.1849388Z",
"CreatedById": null,
"Guid": "cc62d4de-96fe-40be-97fe-15588c31ac47",
"IsDeleted": false
},
{
"Value": "2 (Medium)",
"Position": 0,
"IsArchived": false,
"IsDefault": true,
"IsSystem": false,
"ParentId": null,
"Id": 12,
"ModifiedDate": "2020-12-22T22:18:11.1849388Z",
"ModifiedById": null,
"CreatedDate": "2020-12-22T22:18:11.1849388Z",
"CreatedById": null,
"Guid": "f911c2e7-6a72-45f8-b203-a5f749aee0dd",
"IsDeleted": false
},
{
"Value": "3 (Low)",
"Position": 0,
"IsArchived": false,
"IsDefault": false,
"IsSystem": false,
"ParentId": null,
"Id": 13,
"ModifiedDate": "2020-12-22T22:18:11.1849388Z",
"ModifiedById": null,
"CreatedDate": "2020-12-22T22:18:11.1849388Z",
"CreatedById": null,
"Guid": "a2658a2a-b4a8-4f51-952d-1f9e62fc6f19",
"IsDeleted": false
}
]
}
GET
https://app.tikit.ai/api/SlaState
Get SLA State Values
This endpoint, with no filter criteria or any other parameters, will return an array of all SLA states and properties.
Response Schema Hide
{
"type": "object",
"properties": {
"@odata.context": {
"type": "string",
"format": "uri"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Id": {
"type": "integer"
},
"Name": {
"type": "string"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/SlaState"
fetch("https://app.tikit.ai/api/SlaState", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/SlaState" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#SlaState",
"value": [
{
"Id": 1,
"Name": "Active",
"ModifiedDate": "2022-06-16T02:18:57.297796Z",
"ModifiedById": null,
"CreatedDate": "2022-06-16T02:18:57.297796Z",
"CreatedById": null,
"Guid": "88ff7a7f-e8b6-4a1e-bde0-e8ec13a729b0",
"IsDeleted": false
},
{
"Id": 2,
"Name": "Approach Breached",
"ModifiedDate": "2022-06-16T02:18:57.297796Z",
"ModifiedById": null,
"CreatedDate": "2022-06-16T02:18:57.297796Z",
"CreatedById": null,
"Guid": "35fd8631-a147-4ce9-80f7-9b40a7e9544c",
"IsDeleted": false
},
{
"Id": 3,
"Name": "Breached",
"ModifiedDate": "2022-06-16T02:18:57.297796Z",
"ModifiedById": null,
"CreatedDate": "2022-06-16T02:18:57.297796Z",
"CreatedById": null,
"Guid": "0f0efe9c-34a7-4edb-9f1a-fab0b8368d7a",
"IsDeleted": false
},
{
"Id": 4,
"Name": "Satisfied",
"ModifiedDate": "2022-06-16T02:18:57.297796Z",
"ModifiedById": null,
"CreatedDate": "2022-06-16T02:18:57.297796Z",
"CreatedById": null,
"Guid": "cea8d666-2566-473f-973a-0397c6988ff5",
"IsDeleted": false
}
]
}
GET
https://app.tikit.ai/api/Status
Get Status Values
This endpoint, with no filter criteria or any other parameters, will return an array of all status' and properties.
Response Schema Hide
{
"type": "object",
"properties": {
"@odata.context": {
"type": "string",
"format": "uri"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Value": {
"type": "string"
},
"Position": {
"type": "integer"
},
"IsArchived": {
"type": "boolean"
},
"IsDefault": {
"type": "boolean"
},
"IsSystem": {
"type": "boolean"
},
"ParentId": {
"type": [
"integer"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/Status"
fetch("https://app.tikit.ai/api/Status", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/Status" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#Status",
"value": [
{
"Value": "Active",
"Position": 2,
"IsArchived": false,
"IsDefault": true,
"IsSystem": true,
"ParentId": null,
"Id": 16,
"ModifiedDate": "2025-04-08T15:14:30.5277257Z",
"ModifiedById": 1,
"CreatedDate": "2020-12-22T22:18:11.1849388Z",
"CreatedById": null,
"Guid": "1a2c8296-d733-43a6-8f15-63f86618f7f8",
"IsDeleted": false
},
{
"Value": "Pending",
"Position": 3,
"IsArchived": false,
"IsDefault": false,
"IsSystem": true,
"ParentId": null,
"Id": 17,
"ModifiedDate": "2025-01-27T19:32:41.0531686Z",
"ModifiedById": 1,
"CreatedDate": "2020-12-22T22:18:11.1849388Z",
"CreatedById": null,
"Guid": "9446fd6f-69de-4e36-81e4-6241e2e0fd8e",
"IsDeleted": false
},
{
"Value": "Resolved",
"Position": 4,
"IsArchived": false,
"IsDefault": false,
"IsSystem": true,
"ParentId": null,
"Id": 18,
"ModifiedDate": "2025-01-27T19:32:41.1933867Z",
"ModifiedById": 1,
"CreatedDate": "2020-12-22T22:18:11.1849388Z",
"CreatedById": null,
"Guid": "3018134d-1ca5-4fb6-a079-dc05959f3acc",
"IsDeleted": false
},
{
"Value": "Closed",
"Position": 5,
"IsArchived": false,
"IsDefault": false,
"IsSystem": true,
"ParentId": null,
"Id": 19,
"ModifiedDate": "2025-01-27T19:32:41.223565Z",
"ModifiedById": 1,
"CreatedDate": "2020-12-22T22:18:11.1849388Z",
"CreatedById": null,
"Guid": "d218170f-b01a-45a1-81d3-8ce3cee92a63",
"IsDeleted": false
},
{
"Value": "Deflected",
"Position": 6,
"IsArchived": false,
"IsDefault": false,
"IsSystem": true,
"ParentId": null,
"Id": 25,
"ModifiedDate": "2025-01-27T19:32:41.2493426Z",
"ModifiedById": 1,
"CreatedDate": "2021-03-31T01:36:26.5128577Z",
"CreatedById": null,
"Guid": "d45d1c82-1e10-44fc-a10c-54b9d7c40c1a",
"IsDeleted": false
},
{
"Value": "Canceled",
"Position": 1,
"IsArchived": false,
"IsDefault": false,
"IsSystem": false,
"ParentId": 19,
"Id": 44,
"ModifiedDate": "2025-01-27T19:32:47.9648042Z",
"ModifiedById": 1,
"CreatedDate": "2025-01-27T19:32:40.4897678Z",
"CreatedById": 1,
"Guid": "cf01050d-260e-48b4-8be0-60503557e9b7",
"IsDeleted": false
}
]
}
GET
https://app.tikit.ai/api/TaskStatus
Get Task Status Values
This endpoint, with no filter criteria or any other parameters, will return an array of all task status' and properties.
Response Schema Hide
{
"type": "object",
"properties": {
"@odata.context": {
"type": "string",
"format": "uri"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Value": {
"type": "string"
},
"Position": {
"type": "integer"
},
"IsArchived": {
"type": "boolean"
},
"IsDefault": {
"type": "boolean"
},
"IsSystem": {
"type": "boolean"
},
"ParentId": {
"type": [
"integer"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
},
"IsPowerAutomateStatus": {
"type": "boolean"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/TaskStatus"
fetch("https://app.tikit.ai/api/TaskStatus", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/TaskStatus" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#TaskStatus",
"value": [
{
"Value": "Not Started",
"Position": 0,
"IsArchived": false,
"IsDefault": true,
"IsSystem": false,
"ParentId": null,
"Id": 31,
"ModifiedDate": "2023-07-18T03:24:50.5670551Z",
"ModifiedById": null,
"CreatedDate": "2023-07-18T03:24:50.5670551Z",
"CreatedById": null,
"Guid": "77130d3f-e795-497e-bbbb-780910efa501",
"IsDeleted": false,
"IsPowerAutomateStatus": false
},
{
"Value": "In Progress",
"Position": 0,
"IsArchived": false,
"IsDefault": false,
"IsSystem": false,
"ParentId": null,
"Id": 32,
"ModifiedDate": "2023-07-18T03:24:50.5670551Z",
"ModifiedById": null,
"CreatedDate": "2023-07-18T03:24:50.5670551Z",
"CreatedById": null,
"Guid": "86873792-6194-4147-8fa0-0d808096a8f8",
"IsDeleted": false,
"IsPowerAutomateStatus": false
},
{
"Value": "Completed",
"Position": 0,
"IsArchived": false,
"IsDefault": false,
"IsSystem": false,
"ParentId": null,
"Id": 33,
"ModifiedDate": "2023-07-18T03:24:50.5670551Z",
"ModifiedById": null,
"CreatedDate": "2023-07-18T03:24:50.5670551Z",
"CreatedById": null,
"Guid": "eec5783c-e3b4-4a27-ae98-e5761b77d523",
"IsDeleted": false,
"IsPowerAutomateStatus": false
},
{
"Value": "Failed",
"Position": 0,
"IsArchived": false,
"IsDefault": false,
"IsSystem": false,
"ParentId": null,
"Id": 34,
"ModifiedDate": "2023-07-18T03:24:50.5670551Z",
"ModifiedById": null,
"CreatedDate": "2023-07-18T03:24:50.5670551Z",
"CreatedById": null,
"Guid": "6b26ede9-1373-41c2-926c-d46eede98eb8",
"IsDeleted": false,
"IsPowerAutomateStatus": false
},
{
"Value": "Failed",
"Position": 0,
"IsArchived": false,
"IsDefault": false,
"IsSystem": false,
"ParentId": null,
"Id": 39,
"ModifiedDate": "2024-01-16T04:39:29.8188916Z",
"ModifiedById": null,
"CreatedDate": "2024-01-16T04:39:29.8188916Z",
"CreatedById": null,
"Guid": "feffbb01-2f46-4f97-b6aa-4fdbc4838040",
"IsDeleted": false,
"IsPowerAutomateStatus": true
},
{
"Value": "Cancelled",
"Position": 0,
"IsArchived": false,
"IsDefault": false,
"IsSystem": false,
"ParentId": null,
"Id": 40,
"ModifiedDate": "2024-01-16T04:39:29.8188916Z",
"ModifiedById": null,
"CreatedDate": "2024-01-16T04:39:29.8188916Z",
"CreatedById": null,
"Guid": "3926607e-b100-4785-b5c0-7caba398214b",
"IsDeleted": false,
"IsPowerAutomateStatus": true
},
{
"Value": "Succeeded",
"Position": 0,
"IsArchived": false,
"IsDefault": false,
"IsSystem": false,
"ParentId": null,
"Id": 41,
"ModifiedDate": "2024-01-16T04:39:29.8188916Z",
"ModifiedById": null,
"CreatedDate": "2024-01-16T04:39:29.8188916Z",
"CreatedById": null,
"Guid": "85bc29f1-8f5a-476b-90b9-016964d906f0",
"IsDeleted": false,
"IsPowerAutomateStatus": true
},
{
"Value": "In Progress",
"Position": 0,
"IsArchived": false,
"IsDefault": false,
"IsSystem": false,
"ParentId": null,
"Id": 42,
"ModifiedDate": "2024-01-16T04:39:29.8188916Z",
"ModifiedById": null,
"CreatedDate": "2024-01-16T04:39:29.8188916Z",
"CreatedById": null,
"Guid": "96177ace-cd75-4972-bace-8bdb9bf6282d",
"IsDeleted": false,
"IsPowerAutomateStatus": true
},
{
"Value": "Skipped",
"Position": 0,
"IsArchived": false,
"IsDefault": false,
"IsSystem": false,
"ParentId": null,
"Id": 43,
"ModifiedDate": "2024-12-19T03:35:39.4409851Z",
"ModifiedById": null,
"CreatedDate": "2024-12-19T03:35:39.4409851Z",
"CreatedById": null,
"Guid": "acaeeb0c-d4e4-479e-9d25-b548e73c0a35",
"IsDeleted": false,
"IsPowerAutomateStatus": false
}
]
}
GET
https://app.tikit.ai/api/TicketType
Get Ticket Type Values
This endpoint, with no filter criteria or any other parameters, will return an array of all ticket types and properties.
Response Schema Hide
{
"type": "object",
"properties": {
"@odata.context": {
"type": "string",
"format": "uri"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Value": {
"type": "string"
},
"Position": {
"type": "integer"
},
"IsArchived": {
"type": "boolean"
},
"IsDefault": {
"type": "boolean"
},
"IsSystem": {
"type": "boolean"
},
"ParentId": {
"type": [
"integer"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/TicketType"
fetch("https://app.tikit.ai/api/TicketType", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/TicketType" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#TicketType",
"value": [
{
"Value": "Incident",
"Position": 0,
"IsArchived": false,
"IsDefault": true,
"IsSystem": true,
"ParentId": null,
"Id": 28,
"ModifiedDate": "2023-07-18T03:24:50.5670551Z",
"ModifiedById": null,
"CreatedDate": "2023-07-18T03:24:50.5670551Z",
"CreatedById": null,
"Guid": "b420e1d9-481a-4195-87bf-440c8b269e3f",
"IsDeleted": false
},
{
"Value": "Request",
"Position": 0,
"IsArchived": false,
"IsDefault": false,
"IsSystem": true,
"ParentId": null,
"Id": 29,
"ModifiedDate": "2023-07-18T03:24:50.5670551Z",
"ModifiedById": null,
"CreatedDate": "2023-07-18T03:24:50.5670551Z",
"CreatedById": null,
"Guid": "e4fe7f4b-c709-4aa4-b0c5-895a542e3fa7",
"IsDeleted": false
},
{
"Value": "Change",
"Position": 0,
"IsArchived": false,
"IsDefault": false,
"IsSystem": true,
"ParentId": null,
"Id": 30,
"ModifiedDate": "2023-07-18T03:24:50.5670551Z",
"ModifiedById": null,
"CreatedDate": "2023-07-18T03:24:50.5670551Z",
"CreatedById": null,
"Guid": "0773e3a9-b56e-4a50-8aeb-8ff9fe82aae8",
"IsDeleted": false
},
{
"Value": "Problem",
"Position": 0,
"IsArchived": false,
"IsDefault": false,
"IsSystem": false,
"ParentId": null,
"Id": 49,
"ModifiedDate": "2025-05-26T15:43:45.3010715Z",
"ModifiedById": 1,
"CreatedDate": "2025-05-26T15:43:45.3010715Z",
"CreatedById": 1,
"Guid": "35fb0bab-3207-4e85-8c9a-d36786f41253",
"IsDeleted": false
},
{
"Value": "Change - Emergency",
"Position": 1,
"IsArchived": false,
"IsDefault": false,
"IsSystem": false,
"ParentId": 30,
"Id": 50,
"ModifiedDate": "2025-05-27T02:08:13.905905Z",
"ModifiedById": 1,
"CreatedDate": "2025-05-26T15:49:19.0313072Z",
"CreatedById": 1,
"Guid": "3dd21f31-357f-4c39-abe7-48adbe4fdc91",
"IsDeleted": false
},
{
"Value": "Change - Standard",
"Position": 2,
"IsArchived": false,
"IsDefault": false,
"IsSystem": false,
"ParentId": 30,
"Id": 51,
"ModifiedDate": "2025-05-27T02:08:17.834863Z",
"ModifiedById": 1,
"CreatedDate": "2025-05-26T15:49:30.5696611Z",
"CreatedById": 1,
"Guid": "03505fed-0f8e-4a31-bac5-d529e0689f9f",
"IsDeleted": false
},
{
"Value": "Change - Normal",
"Position": 3,
"IsArchived": false,
"IsDefault": false,
"IsSystem": false,
"ParentId": 30,
"Id": 52,
"ModifiedDate": "2025-05-27T02:08:22.0581978Z",
"ModifiedById": 1,
"CreatedDate": "2025-05-26T15:50:38.9637676Z",
"CreatedById": 1,
"Guid": "f06c0b40-8839-47d3-bd4d-32ca459cd3d4",
"IsDeleted": false
}
]
}
POST
https://app.tikit.ai/api/Category
Create Category Value
This endpoint is used to create a category value. The category properties should be passed as the JSON body payload.
-
-
-
-
-
Parameters
-
Value(string, required) - The name of the category to be created
-
ParentId(integer, optional) - The Id of the category this category should be nested under
-
Position(integer, optional) - The ordering position of this category in the category list
-
IsArchived(boolean, optional) - Whether the category is archived or not
-
IsDefault(boolean, optional) - If the category value should be the default category value for new tickets
Response Schema Hide
{
"type": "object",
"properties": {
"@odata.context": {
"type": "string",
"format": "uri"
},
"Value": {
"type": "string"
},
"Position": {
"type": "integer"
},
"IsArchived": {
"type": "boolean"
},
"IsDefault": {
"type": "boolean"
},
"IsSystem": {
"type": "boolean"
},
"ParentId": {
"type": [
"integer"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
Code Samples
curl -X POST -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/Category"
fetch("https://app.tikit.ai/api/Category", { method: "POST", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/Category" -Method POST -Headers @{Authorization = "Bearer <token>"}Request Example
{
"Value": "VPN",
"ParentId": 1
}
Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#Category/$entity",
"Value": "VPN",
"Position": 0,
"IsArchived": false,
"IsDefault": false,
"IsSystem": false,
"ParentId": 1,
"Id": 72,
"ModifiedDate": "2025-06-02T15:49:03.4928791Z",
"ModifiedById": 1,
"CreatedDate": "2025-06-02T15:49:03.4928791Z",
"CreatedById": 1,
"Guid": "7c82a473-08d6-4f74-84b6-8d43914ac450",
"IsDeleted": false
}
POST
https://app.tikit.ai/api/Priority
Create Priority Value
This endpoint is used to create a priority value. The priority properties should be passed as the JSON body payload.
-
-
-
-
-
Parameters
-
Value(string, required) - The name of the priority to be created
-
ParentId(integer, optional) - The Id of the priority this priority should be nested under
-
Position(integer, optional) - The ordering position of this priority in the priority list
-
IsArchived(boolean, optional) - Whether the priority is archived or not
-
IsDefault(boolean, optional) - If the priority value should be the default priority value for new tickets
Response Schema Hide
{
"type": "object",
"properties": {
"@odata.context": {
"type": "string",
"format": "uri"
},
"Value": {
"type": "string"
},
"Position": {
"type": "integer"
},
"IsArchived": {
"type": "boolean"
},
"IsDefault": {
"type": "boolean"
},
"IsSystem": {
"type": "boolean"
},
"ParentId": {
"type": [
"integer"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
Code Samples
curl -X POST -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/Priority"
fetch("https://app.tikit.ai/api/Priority", { method: "POST", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/Priority" -Method POST -Headers @{Authorization = "Bearer <token>"}Request Example
{
"Value": "VIP",
"ParentId": 11
}
Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#Priority/$entity",
"Value": "VIP",
"Position": 0,
"IsArchived": false,
"IsDefault": false,
"IsSystem": false,
"ParentId": 11,
"Id": 73,
"ModifiedDate": "2025-06-02T16:35:14.1602087Z",
"ModifiedById": 1,
"CreatedDate": "2025-06-02T16:35:14.1602087Z",
"CreatedById": 1,
"Guid": "52d0ccac-441d-4508-909b-159e295557c0",
"IsDeleted": false
}
POST
https://app.tikit.ai/api/Status
Create Status Value
This endpoint is used to create a status value. The status properties should be passed as the JSON body payload.
-
-
-
-
-
Parameters
-
Value(string, required) - The name of the status to be created
-
ParentId(integer, optional) - The Id of the status this status should be nested under
-
Position(integer, optional) - The ordering position of this status in the status list
-
IsArchived(boolean, optional) - Whether the status is archived or not
-
IsDefault(boolean, optional) - If the status value should be the default status value for new tickets
Response Schema Hide
{
"type": "object",
"properties": {
"@odata.context": {
"type": "string",
"format": "uri"
},
"Value": {
"type": "string"
},
"Position": {
"type": "integer"
},
"IsArchived": {
"type": "boolean"
},
"IsDefault": {
"type": "boolean"
},
"IsSystem": {
"type": "boolean"
},
"ParentId": {
"type": [
"integer"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
Code Samples
curl -X POST -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/Status"
fetch("https://app.tikit.ai/api/Status", { method: "POST", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/Status" -Method POST -Headers @{Authorization = "Bearer <token>"}Request Example
{
"Value": "Pending Approval",
"ParentId": 17
}
Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#Status/$entity",
"Value": "Pending Approval",
"Position": 0,
"IsArchived": false,
"IsDefault": false,
"IsSystem": false,
"ParentId": 17,
"Id": 74,
"ModifiedDate": "2025-06-02T18:06:57.1972704Z",
"ModifiedById": 1,
"CreatedDate": "2025-06-02T18:06:57.1972704Z",
"CreatedById": 1,
"Guid": "c2ddedb0-10ed-478d-ab26-5f0bc800a797",
"IsDeleted": false
}
POST
https://app.tikit.ai/api/TicketType
Create TicketType Value
This endpoint is used to create a ticket type value. The ticket type properties should be passed as the JSON body payload.
-
-
-
-
-
Parameters
-
Value(string, required) - The name of the ticket type to be created
-
ParentId(integer, optional) - The Id of the ticket type this ticket type should be nested under
-
Position(integer, optional) - The ordering position of this ticket type in the ticket type list
-
IsArchived(boolean, optional) - Whether the ticket type is archived or not
-
IsDefault(boolean, optional) - If the ticket type value should be the default ticket type value for new tickets
Response Schema Hide
{
"type": "object",
"properties": {
"@odata.context": {
"type": "string",
"format": "uri"
},
"Value": {
"type": "string"
},
"Position": {
"type": "integer"
},
"IsArchived": {
"type": "boolean"
},
"IsDefault": {
"type": "boolean"
},
"IsSystem": {
"type": "boolean"
},
"ParentId": {
"type": [
"integer"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
Code Samples
curl -X POST -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/TicketType"
fetch("https://app.tikit.ai/api/TicketType", { method: "POST", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/TicketType" -Method POST -Headers @{Authorization = "Bearer <token>"}Request Example
{
"Value": "Change - Normal",
"ParentId": 30
}
Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#TicketType/$entity",
"Value": "Change - Normal",
"Position": 0,
"IsArchived": false,
"IsDefault": false,
"IsSystem": false,
"ParentId": 30,
"Id": 75,
"ModifiedDate": "2025-06-02T18:16:19.4019155Z",
"ModifiedById": 1,
"CreatedDate": "2025-06-02T18:16:19.4019155Z",
"CreatedById": 1,
"Guid": "076c5b1c-1a22-4fc2-ae30-13e51d561a61",
"IsDeleted": false
}
Resolutions
GET
https://app.tikit.ai/api/Resolution
Get Resolutions
This endpoint, with no filter criteria or any other parameters, will return an array of all ticket resolutions and properties.
Response Schema Hide
{
"title": "ResolutionResponse",
"type": "object",
"properties": {
"@odata.context": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Note": {
"type": "string"
},
"InternalNote": {
"type": "string"
},
"DraftKB": {
"type": "boolean"
},
"ResolutionCategoryId": {
"type": "integer"
},
"AnswerId": {
"type": [
"integer"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/Resolution"
fetch("https://app.tikit.ai/api/Resolution", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/Resolution" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#Resolution",
"value": [
{
"Note": "Resolved ticket",
"InternalNote": "",
"DraftKB": false,
"ResolutionCategoryId": 45,
"AnswerId": null,
"Id": 8,
"ModifiedDate": "2025-05-27T19:02:23.7592148Z",
"ModifiedById": 1,
"CreatedDate": "2025-05-27T19:02:23.7592148Z",
"CreatedById": 1,
"Guid": "91c0867b-8fac-4e37-b98c-30fe64156063",
"IsDeleted": false
},
{
"Note": "Resolved by Henrietta",
"InternalNote": "",
"DraftKB": false,
"ResolutionCategoryId": 45,
"AnswerId": null,
"Id": 9,
"ModifiedDate": "2025-05-27T19:05:51.6171585Z",
"ModifiedById": 2,
"CreatedDate": "2025-05-27T19:05:51.6171585Z",
"CreatedById": 2,
"Guid": "6d1d882a-4cf0-476f-abc0-8784eecf3399",
"IsDeleted": false
},
{
"Note": "resolved",
"InternalNote": "",
"DraftKB": false,
"ResolutionCategoryId": 47,
"AnswerId": null,
"Id": 13,
"ModifiedDate": "2025-06-05T18:41:45.3985074Z",
"ModifiedById": null,
"CreatedDate": "2025-06-05T18:41:45.3985074Z",
"CreatedById": null,
"Guid": "8b2e3ab6-6f5d-4be3-820a-5aee2a03edfc",
"IsDeleted": false
}
]
}
SLAs
GET
https://app.tikit.ai/api/ServiceLevelAgreement
Get SLA Configurations
This endpoint, with no filter criteria or any other parameters, will return an array of all configured SLAs.
Response Schema Hide
{
"title": "ServiceLevelAgreementResponse",
"type": "object",
"properties": {
"@odata.context": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Id": {
"type": "integer"
},
"Name": {
"type": "string"
},
"IsActive": {
"type": "boolean"
},
"SlaRuleGroupId": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": "integer"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": "integer"
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/ServiceLevelAgreement"
fetch("https://app.tikit.ai/api/ServiceLevelAgreement", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/ServiceLevelAgreement" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#ServiceLevelAgreement",
"value": [
{
"Id": 1,
"Name": "SLA 1",
"IsActive": true,
"SlaRuleGroupId": 1,
"ModifiedDate": "2025-06-16T15:59:21.5074684Z",
"ModifiedById": 1,
"CreatedDate": "2025-06-16T15:59:21.5074684Z",
"CreatedById": 1,
"Guid": "8c5561a6-f46a-4889-aa4d-acf3f9e387e7",
"IsDeleted": false
},
{
"Id": 2,
"Name": "SLA 2",
"IsActive": true,
"SlaRuleGroupId": 2,
"ModifiedDate": "2025-06-16T16:00:48.1429467Z",
"ModifiedById": 1,
"CreatedDate": "2025-06-16T16:00:48.1429467Z",
"CreatedById": 1,
"Guid": "66022bdd-00e2-4053-9011-6a64d75a5179",
"IsDeleted": false
}
]
}
GET
https://app.tikit.ai/api/TicketSla
Get Ticket SLA Instances
This endpoint, with no filter criteria or any other parameters, will return an array of all tickets and properties with an SLA applied.
Response Schema Hide
{
"title": "TicketSlaResponse",
"type": "object",
"properties": {
"@odata.context": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Id": {
"type": "integer"
},
"TicketId": {
"type": "integer"
},
"ServiceLevelAgreementId": {
"type": "integer"
},
"SlaStateId": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": "integer"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": "integer"
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/TicketSla"
fetch("https://app.tikit.ai/api/TicketSla", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/TicketSla" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#TicketSla",
"value": [
{
"Id": 1,
"TicketId": 10,
"ServiceLevelAgreementId": 2,
"SlaStateId": 1,
"ModifiedDate": "2025-06-16T20:10:48.5607757Z",
"ModifiedById": 1,
"CreatedDate": "2025-06-16T20:10:48.5607757Z",
"CreatedById": 1,
"Guid": "b648ee7c-f45f-4c55-bd26-b9f351c073b7",
"IsDeleted": false
},
{
"Id": 2,
"TicketId": 11,
"ServiceLevelAgreementId": 2,
"SlaStateId": 1,
"ModifiedDate": "2025-06-16T20:10:48.5607757Z",
"ModifiedById": 1,
"CreatedDate": "2025-06-16T20:10:48.5607757Z",
"CreatedById": 1,
"Guid": "6cec4d68-0c1b-41b5-9d74-0009d9f98195",
"IsDeleted": false
},
{
"Id": 3,
"TicketId": 13,
"ServiceLevelAgreementId": 2,
"SlaStateId": 1,
"ModifiedDate": "2025-06-16T20:10:48.5607757Z",
"ModifiedById": 1,
"CreatedDate": "2025-06-16T20:10:48.5607757Z",
"CreatedById": 1,
"Guid": "7ef48955-033f-4347-9f0e-c334c133d3de",
"IsDeleted": false
},
{
"Id": 4,
"TicketId": 14,
"ServiceLevelAgreementId": 2,
"SlaStateId": 1,
"ModifiedDate": "2025-06-16T20:10:48.5607757Z",
"ModifiedById": 1,
"CreatedDate": "2025-06-16T20:10:48.5607757Z",
"CreatedById": 1,
"Guid": "a950f547-7945-4692-9145-58473a499827",
"IsDeleted": false
},
{
"Id": 5,
"TicketId": 38,
"ServiceLevelAgreementId": 2,
"SlaStateId": 1,
"ModifiedDate": "2025-06-16T20:10:48.5607757Z",
"ModifiedById": 1,
"CreatedDate": "2025-06-16T20:10:48.5607757Z",
"CreatedById": 1,
"Guid": "7c5c4992-3927-4449-bd28-41e07dd84de0",
"IsDeleted": false
}
]
}
Tags
GET
https://app.tikit.ai/api/Tag
Get Tags
This endpoint, with no filter criteria or any other parameters, will return an array of all tags and properties.
Response Schema Hide
{
"type": "object",
"properties": {
"@odata.context": {
"type": "string",
"format": "uri"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
},
"Name": {
"type": "string"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/Tag"
fetch("https://app.tikit.ai/api/Tag", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/Tag" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://platformapp-07.azurewebsites.net/api/$metadata#Tag",
"value": [
{
"Id": 1,
"ModifiedDate": "2025-05-26T17:55:08.0117657Z",
"ModifiedById": 1,
"CreatedDate": "2024-10-02T12:26:37.9900827Z",
"CreatedById": 1,
"Guid": "c0005fa6-6080-4873-804c-107883badd88",
"IsDeleted": false,
"Name": "VIP"
},
{
"Id": 4,
"ModifiedDate": "2025-06-02T18:23:03.5611688Z",
"ModifiedById": 1,
"CreatedDate": "2025-06-02T18:23:03.5611688Z",
"CreatedById": 1,
"Guid": "a6c2aacd-a80e-48c1-b7cd-ea18357759ab",
"IsDeleted": false,
"Name": "Enhancement"
}
]
}
POST
https://app.tikit.ai/api/Tag
Create Tag
This endpoint is used to create a tag. The tag properties should be passed as the JSON body payload.
-
Parameters
-
Name(string, required) - The name of the tag to be created
Response Schema Hide
{
"type": "object",
"properties": {
"@odata.context": {
"type": "string",
"format": "uri"
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
},
"Name": {
"type": "string"
}
}
}
Code Samples
curl -X POST -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/Tag"
fetch("https://app.tikit.ai/api/Tag", { method: "POST", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/Tag" -Method POST -Headers @{Authorization = "Bearer <token>"}Request Example
{
"Name": "Legacy"
}
Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#Tag/$entity",
"Id": 5,
"ModifiedDate": "2025-06-02T18:42:00.1907038Z",
"ModifiedById": 1,
"CreatedDate": "2025-06-02T18:42:00.1907038Z",
"CreatedById": 1,
"Guid": "d46e19c5-d69a-4090-99fe-f5c4ea290df2",
"IsDeleted": false,
"Name": "Legacy"
}
Tasks
GET
https://app.tikit.ai/api/LifecyclePowerAutomateTask
Get Lifecycle Power Automate Tasks
This endpoint, with no filter criteria or any other parameters, will return an array of all Power Automate tasks and properties.
Response Schema Hide
{
"title": "LifecyclePowerAutomateTaskResponse",
"type": "object",
"properties": {
"@odata.context": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"Description": {
"type": [
"string"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": "integer"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": "integer"
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
},
"AssigneeId": {
"type": [
"integer"
]
},
"LifecyclePhaseId": {
"type": "integer"
},
"IsPowerAutomateTask": {
"type": "boolean"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/LifecyclePowerAutomateTask"
fetch("https://app.tikit.ai/api/LifecyclePowerAutomateTask", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/LifecyclePowerAutomateTask" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#LifecyclePowerAutomateTask",
"value": [
{
"Name": "Update Ticket Title",
"Description": null,
"Id": 9,
"ModifiedDate": "2024-08-06T14:02:52.1108152Z",
"ModifiedById": 1,
"CreatedDate": "2024-08-06T14:02:52.1108152Z",
"CreatedById": 1,
"Guid": "a347eacb-d990-401f-ab5b-1e91fc64f13e",
"IsDeleted": false,
"AssigneeId": null,
"LifecyclePhaseId": 8,
"IsPowerAutomateTask": true
},
{
"Name": "Create Entra Account",
"Description": null,
"Id": 14,
"ModifiedDate": "2024-08-06T14:02:53.6072019Z",
"ModifiedById": 1,
"CreatedDate": "2024-08-06T14:02:53.6072019Z",
"CreatedById": 1,
"Guid": "1ebcabc0-5c66-4b28-9e66-e584fbf43a94",
"IsDeleted": false,
"AssigneeId": null,
"LifecyclePhaseId": 13,
"IsPowerAutomateTask": true
},
{
"Name": "Add to Support Team",
"Description": null,
"Id": 16,
"ModifiedDate": "2024-08-06T14:02:53.8630011Z",
"ModifiedById": 1,
"CreatedDate": "2024-08-06T14:02:53.8630011Z",
"CreatedById": 1,
"Guid": "f4ba471a-55e3-4aea-85bf-70af1094368e",
"IsDeleted": false,
"AssigneeId": null,
"LifecyclePhaseId": 15,
"IsPowerAutomateTask": true
}
]
}
GET
https://app.tikit.ai/api/LifecycleTask
Get Lifecycle Tasks
This endpoint, with no filter criteria or any other parameters, will return an array of all lifecycle tasks and properties.
Response Schema Hide
{
"title": "LifecycleTaskResponse",
"type": "object",
"properties": {
"@odata.context": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"Description": {
"type": [
"string"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": "integer"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": "integer"
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
},
"AssigneeId": {
"type": "integer"
},
"LifecyclePhaseId": {
"type": "integer"
},
"IsPowerAutomateTask": {
"type": "boolean"
},
"TeamId": {
"type": "integer"
},
"SupportGroupId": {
"type": "integer"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/LifecycleTask"
fetch("https://app.tikit.ai/api/LifecycleTask", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/LifecycleTask" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#LifecycleTask",
"value": [
{
"Name": "Remove Account",
"Description": null,
"Id": 21,
"ModifiedDate": "2025-06-19T13:56:53.7772276Z",
"ModifiedById": 1,
"CreatedDate": "2025-01-27T19:43:46.9779689Z",
"CreatedById": 1,
"Guid": "45a8eed2-bc60-4a6a-a1f7-01b123c56a9a",
"IsDeleted": false,
"AssigneeId": 2,
"LifecyclePhaseId": 19,
"IsPowerAutomateTask": false,
"TeamId": 1,
"SupportGroupId": 2
},
{
"Name": "Add Team",
"Description": null,
"Id": 33,
"ModifiedDate": "2025-06-19T13:56:53.7719278Z",
"ModifiedById": 1,
"CreatedDate": "2025-06-19T13:56:53.7719278Z",
"CreatedById": 1,
"Guid": "d6acdb1f-6c0e-4b5c-96c6-00da2ff809bb",
"IsDeleted": false,
"AssigneeId": 4,
"LifecyclePhaseId": 19,
"IsPowerAutomateTask": false,
"TeamId": 1,
"SupportGroupId": 1
},
{
"Name": "Review Logs",
"Description": null,
"Id": 34,
"ModifiedDate": "2025-06-19T13:56:53.7719278Z",
"ModifiedById": 1,
"CreatedDate": "2025-06-19T13:56:53.7719278Z",
"CreatedById": 1,
"Guid": "d2360d4d-e107-463a-8d53-e28b529992f4",
"IsDeleted": false,
"AssigneeId": 6,
"LifecyclePhaseId": 19,
"IsPowerAutomateTask": false,
"TeamId": 1,
"SupportGroupId": 4
}
]
}
GET
https://app.tikit.ai/api/TicketTask
Get Ticket Tasks
This endpoint, with no filter criteria or any other parameters, will return an array of all ticket tasks and properties.
Response Schema Hide
{
"title": "TicketTaskResponse",
"type": "object",
"properties": {
"@odata.context": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Title": {
"type": "string"
},
"StatusId": {
"type": "integer"
},
"AssigneeId": {
"type": "integer"
},
"TicketId": {
"type": "integer"
},
"IsPowerAutomateTask": {
"type": "boolean"
},
"TicketLifecyclePhaseId": {
"type": [
"integer"
]
},
"TeamId": {
"type": [
"integer"
]
},
"SupportGroupId": {
"type": [
"integer"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": "integer"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/TicketTask"
fetch("https://app.tikit.ai/api/TicketTask", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/TicketTask" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#TicketTask",
"value": [
{
"Title": "Renew License",
"StatusId": 33,
"AssigneeId": 4,
"TicketId": 12,
"IsPowerAutomateTask": false,
"TicketLifecyclePhaseId": 1,
"TeamId": null,
"SupportGroupId": null,
"Id": 1,
"ModifiedDate": "2024-07-05T18:49:36.544162Z",
"ModifiedById": 4,
"CreatedDate": "2024-07-05T18:48:32.0508289Z",
"CreatedById": null,
"Guid": "93d05c38-d5ac-41af-bc05-31c4ba1aee20",
"IsDeleted": false
},
{
"Title": "Reset Password",
"StatusId": 31,
"AssigneeId": 4,
"TicketId": 9,
"IsPowerAutomateTask": false,
"TicketLifecyclePhaseId": null,
"TeamId": null,
"SupportGroupId": null,
"Id": 2,
"ModifiedDate": "2024-07-05T19:51:57.900459Z",
"ModifiedById": 1,
"CreatedDate": "2024-07-05T19:51:57.900459Z",
"CreatedById": 1,
"Guid": "5bb27471-0b4b-47a6-8507-628728b03c30",
"IsDeleted": false
},
{
"Title": "Fix a problem",
"StatusId": 33,
"AssigneeId": 4,
"TicketId": 13,
"IsPowerAutomateTask": false,
"TicketLifecyclePhaseId": 2,
"TeamId": null,
"SupportGroupId": null,
"Id": 3,
"ModifiedDate": "2025-02-20T17:35:07.9529036Z",
"ModifiedById": 1,
"CreatedDate": "2024-07-08T14:11:55.302589Z",
"CreatedById": null,
"Guid": "eb365e02-2640-428b-8e9f-34f29da6e3c4",
"IsDeleted": false
}
]
}
Teams
GET
https://app.tikit.ai/api/Team
Get Teams
This endpoint, with no filter criteria or any other parameters, will return an array of all teams and properties.
Response Schema Hide
{
"title": "TeamResponse",
"type": "object",
"properties": {
"@odata.context": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"FriendlyName": {
"type": "string"
},
"Description": {
"type": "string"
},
"TeamsId": {
"type": "string"
},
"TeamsAadObjectId": {
"type": [
"string"
]
},
"TeamsChannelId": {
"type": [
"string"
]
},
"TeamsChannelName": {
"type": [
"string"
]
},
"IsDefault": {
"type": "boolean"
},
"EmailAddress": {
"type": "string"
},
"ClientState": {
"type": [
"string"
]
},
"ExpirationDate": {
"type": [
"string"
],
"format": "date-time"
},
"UserId": {
"type": "string"
},
"SubscriptionId": {
"type": "string"
},
"UseTicketDeflection": {
"type": "boolean"
},
"DefaultLocale": {
"type": "string"
},
"EnableMultiDepartmentPicker": {
"type": "boolean"
},
"MultiDepartmentPickerMessage": {
"type": "string"
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": "integer"
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/Team"
fetch("https://app.tikit.ai/api/Team", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/Team" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://platformapp-07.azurewebsites.net/api/$metadata#Team",
"value": [
{
"Name": "Support",
"FriendlyName": "Support",
"Description": "",
"TeamsId": "19:X397NQ8IUT33nm_kjA0JtNWBNuD8EOLU7A_kDoDGk-c1@thread.tacv2",
"TeamsAadObjectId": "507f85f3-a432-4341-9929-7b0d891e8c42",
"TeamsChannelId": "19:c6bea6a2cbba4488a58e8a379f33b489@thread.tacv2",
"TeamsChannelName": "🎟️ Service Desk",
"IsDefault": true,
"EmailAddress": "supportdesk@6pjybx.onmicrosoft.com",
"ClientState": "342666b2-c6e3-43c5-b420-c2c7c46c02e9",
"ExpirationDate": "2025-06-20T06:35:39.2022272Z",
"UserId": "8dd827e9-158d-4004-aaa0-5bc051bc14c8",
"SubscriptionId": "b67901e8-9078-4511-b3ad-1d5fbb1a9bdb",
"UseTicketDeflection": true,
"DefaultLocale": "en-US",
"EnableMultiDepartmentPicker": true,
"MultiDepartmentPickerMessage": "",
"Id": 1,
"ModifiedDate": "2025-06-19T07:35:40.9020585Z",
"ModifiedById": null,
"CreatedDate": "2024-05-15T19:53:35.7986309Z",
"CreatedById": 1,
"Guid": "abace62b-b548-4edd-afdc-4700d5ae5822",
"IsDeleted": false
},
{
"Name": "Sales and Marketing",
"FriendlyName": "Sales and Marketing",
"Description": "",
"TeamsId": "19:ec70b91e039d4cf0aa49d9e2b7965c9b@thread.tacv2",
"TeamsAadObjectId": null,
"TeamsChannelId": null,
"TeamsChannelName": null,
"IsDefault": false,
"EmailAddress": "",
"ClientState": null,
"ExpirationDate": null,
"UserId": "",
"SubscriptionId": "",
"UseTicketDeflection": true,
"DefaultLocale": "en-US",
"EnableMultiDepartmentPicker": false,
"MultiDepartmentPickerMessage": "",
"Id": 2,
"ModifiedDate": "2024-07-03T13:47:57.9716344Z",
"ModifiedById": 1,
"CreatedDate": "2024-07-03T13:43:57.9606022Z",
"CreatedById": 1,
"Guid": "9e770bb5-0a14-4ba0-8171-cb9930e90e3d",
"IsDeleted": false
},
{
"Name": "Retail",
"FriendlyName": "Site Licensing",
"Description": "",
"TeamsId": "19:cc3339d2392e45ce92d4c6b378e6b53f@thread.tacv2",
"TeamsAadObjectId": "10417836-f2a9-44ab-aa62-34d046714638",
"TeamsChannelId": "19:cc3339d2392e45ce92d4c6b378e6b53f@thread.tacv2",
"TeamsChannelName": "General",
"IsDefault": false,
"EmailAddress": "",
"ClientState": null,
"ExpirationDate": null,
"UserId": "",
"SubscriptionId": "",
"UseTicketDeflection": true,
"DefaultLocale": "en-US",
"EnableMultiDepartmentPicker": false,
"MultiDepartmentPickerMessage": "",
"Id": 3,
"ModifiedDate": "2025-05-02T02:30:25.461288Z",
"ModifiedById": null,
"CreatedDate": "2024-07-03T14:01:20.6210941Z",
"CreatedById": 1,
"Guid": "91324902-5fc0-4821-bd27-2be7c1ec88f1",
"IsDeleted": false
}
]
}
POST
https://app.tikit.ai/api/Team
Create Team
This endpoint is used to create a new team in Tikit. The team properties should be passed as the JSON body payload.
-
-
-
-
-
-
-
-
-
-
-
-
Parameters
-
Name(string, required) - The name of the Microsoft team
-
FriendlyName(string, required) - The friendly name of the team
-
Description(string, optional) - The team description
-
TeamsId(string, required) - The Microsoft Teams Id
-
TeamsAadObjectId(string, required) - The Entra Id of the Team
-
TeamsChannelId(string, required) - The Microsoft Teams triage channel Id
-
TeamsChannelName(string, required) - The name of the Microsoft Teams triage channel
-
IsDefault(boolean, required) - If the team should be the default team for new tickets
-
EmailAddress(string, optional) - The connected mailbox email address
-
UserId(string, optional) - The Entra User Id of the connected mailbox
-
DefaultLocale(string, required) - The default locale code
-
UseTicketDeflection(boolean, required) - If ticket deflection is enabled for the team
Response Schema Hide
{
"title": "Team",
"type": "object",
"properties": {
"@odata.context": {
"type": "string",
"description": "OData context URL"
},
"Name": {
"type": "string"
},
"FriendlyName": {
"type": "string"
},
"Description": {
"type": "string"
},
"TeamsId": {
"type": "string"
},
"TeamsAadObjectId": {
"type": "string",
"format": "uuid"
},
"TeamsChannelId": {
"type": "string"
},
"TeamsChannelName": {
"type": "string"
},
"IsDefault": {
"type": "boolean"
},
"EmailAddress": {
"type": "string",
"format": "email"
},
"ClientState": {
"type": [
"string"
]
},
"ExpirationDate": {
"type": [
"string"
],
"format": "date-time"
},
"UserId": {
"type": "string",
"format": "uuid"
},
"SubscriptionId": {
"type": "string"
},
"UseTicketDeflection": {
"type": "boolean"
},
"DefaultLocale": {
"type": "string"
},
"EnableMultiDepartmentPicker": {
"type": "boolean"
},
"MultiDepartmentPickerMessage": {
"type": "string"
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": "integer"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": "integer"
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
Code Samples
curl -X POST -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/Team"
fetch("https://app.tikit.ai/api/Team", { method: "POST", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/Team" -Method POST -Headers @{Authorization = "Bearer <token>"}Request Example
{
"Name": "Digital Initiative Public Relations",
"FriendlyName": "Digital Initiative Public Relations",
"Description": "The DIPR Support Team",
"TeamsId": "19:13168022973e4ea28e1cb7e511451345@thread.tacv2",
"TeamsAadObjectId": "b18d91a3-5d94-45a4-a992-a40e78f921ca",
"TeamsChannelId": "19:4049008f6a8246848ff335a975192a00@thread.tacv2",
"TeamsChannelName": "Inquiries",
"IsDefault": false,
"EmailAddress": "supportdesk@6pjybx.onmicrosoft.com",
"UserId": "8dd427e9-158d-4004-aca0-5bc061bc14c8",
"DefaultLocale": "en-US",
"UseTicketDeflection": true
}
Try it out
PendingHide
Example Hide
Templates
GET
https://app.tikit.ai/api/TicketTemplate({{TempateId}})
Get Ticket Template By Id
This endpoint takes the
TemplateIdparameter to return a single template matching the specified Id.
Response Schema Hide
{
"title": "TicketTemplate",
"type": "object",
"properties": {
"@odata.context": {
"type": "string"
},
"Name": {
"type": "string"
},
"Description": {
"type": [
"string"
]
},
"CardResponseJson": {
"type": "string"
},
"UnsetAssignee": {
"type": "boolean"
},
"AssigneeId": {
"type": [
"integer"
]
},
"UnsetSupportGroup": {
"type": "boolean"
},
"SupportGroupId": {
"type": [
"integer"
]
},
"UnsetTeam": {
"type": "boolean"
},
"TeamId": {
"type": [
"integer"
]
},
"GroupId": {
"type": [
"integer"
]
},
"EscalationId": {
"type": [
"integer"
]
},
"UnsetCategory": {
"type": "boolean"
},
"CategoryId": {
"type": [
"integer"
]
},
"ImpactId": {
"type": [
"integer"
]
},
"PriorityId": {
"type": [
"integer"
]
},
"SourceId": {
"type": [
"integer"
]
},
"StatusId": {
"type": [
"integer"
]
},
"UrgencyId": {
"type": [
"integer"
]
},
"LifecycleId": {
"type": [
"integer"
]
},
"IsArchived": {
"type": "boolean"
},
"UnsetTicketType": {
"type": "boolean"
},
"TicketTypeId": {
"type": [
"integer"
]
},
"DueDate": {
"type": [
"string"
],
"format": "date-time"
},
"RelativeDueDate": {
"type": [
"string"
]
},
"NoCustomForm": {
"type": "boolean"
},
"IsDefault": {
"type": "boolean"
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": "integer"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": "integer"
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/TicketTemplate({{TempateId}})"fetch("https://app.tikit.ai/api/TicketTemplate({{TempateId}})", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/TicketTemplate({{TempateId}})" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#TicketTemplate/$entity",
"Name": "Test template",
"Description": null,
"CardResponseJson": "",
"UnsetAssignee": true,
"AssigneeId": null,
"UnsetSupportGroup": false,
"SupportGroupId": 1,
"UnsetTeam": false,
"TeamId": 1,
"GroupId": null,
"EscalationId": null,
"UnsetCategory": false,
"CategoryId": null,
"ImpactId": null,
"PriorityId": null,
"SourceId": null,
"StatusId": null,
"UrgencyId": null,
"LifecycleId": null,
"IsArchived": false,
"UnsetTicketType": false,
"TicketTypeId": null,
"DueDate": null,
"RelativeDueDate": null,
"NoCustomForm": true,
"IsDefault": false,
"Id": 3,
"ModifiedDate": "2025-04-25T17:53:18.0464384Z",
"ModifiedById": 1,
"CreatedDate": "2025-01-22T18:10:34.6053113Z",
"CreatedById": 1,
"Guid": "ae5a20a4-bd05-4ce6-bf0b-a066cee90482",
"IsDeleted": false
}
GET
https://app.tikit.ai/api/TicketTemplate
Get Ticket Templates
This endpoint, with no filter criteria or any other parameters, will return an array of all templates and properties, including card form data if applicable.
Response Schema Hide
{
"title": "TicketTemplateResponse",
"type": "object",
"properties": {
"@odata.context": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Name": {
"type": [
"string"
]
},
"Description": {
"type": [
"string"
]
},
"CardResponseJson": {
"type": "string"
},
"UnsetAssignee": {
"type": "boolean"
},
"AssigneeId": {
"type": [
"integer"
]
},
"UnsetSupportGroup": {
"type": "boolean"
},
"SupportGroupId": {
"type": [
"integer"
]
},
"UnsetTeam": {
"type": "boolean"
},
"TeamId": {
"type": [
"integer"
]
},
"GroupId": {
"type": [
"integer"
]
},
"EscalationId": {
"type": [
"integer"
]
},
"UnsetCategory": {
"type": "boolean"
},
"CategoryId": {
"type": [
"integer"
]
},
"ImpactId": {
"type": [
"integer"
]
},
"PriorityId": {
"type": [
"integer"
]
},
"SourceId": {
"type": [
"integer"
]
},
"StatusId": {
"type": [
"integer"
]
},
"UrgencyId": {
"type": [
"integer"
]
},
"LifecycleId": {
"type": [
"integer"
]
},
"IsArchived": {
"type": "boolean"
},
"UnsetTicketType": {
"type": "boolean"
},
"TicketTypeId": {
"type": [
"integer"
]
},
"DueDate": {
"type": [
"string"
],
"format": "date-time"
},
"RelativeDueDate": {
"type": [
"string"
]
},
"NoCustomForm": {
"type": "boolean"
},
"IsDefault": {
"type": "boolean"
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": "integer"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": "integer"
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/TicketTemplate"
fetch("https://app.tikit.ai/api/TicketTemplate", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/TicketTemplate" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#TicketTemplate",
"value": [
{
"Name": "Test template",
"Description": null,
"CardResponseJson": "",
"UnsetAssignee": true,
"AssigneeId": null,
"UnsetSupportGroup": false,
"SupportGroupId": 1,
"UnsetTeam": false,
"TeamId": 1,
"GroupId": null,
"EscalationId": null,
"UnsetCategory": false,
"CategoryId": null,
"ImpactId": null,
"PriorityId": null,
"SourceId": null,
"StatusId": null,
"UrgencyId": null,
"LifecycleId": null,
"IsArchived": false,
"UnsetTicketType": false,
"TicketTypeId": null,
"DueDate": null,
"RelativeDueDate": null,
"NoCustomForm": true,
"IsDefault": false,
"Id": 3,
"ModifiedDate": "2025-04-25T17:53:18.0464384Z",
"ModifiedById": 1,
"CreatedDate": "2025-01-22T18:10:34.6053113Z",
"CreatedById": 1,
"Guid": "ae5a20a4-bd05-4ce6-bf0b-a066cee90482",
"IsDeleted": false
},
{
"Name": "New Entra User",
"Description": null,
"CardResponseJson": "{\"$schema\":\"http://adaptivecards.io/schemas/adaptive-card.json\",\"type\":\"AdaptiveCard\",\"version\":\"1.4\",\"body\":[{\"type\":\"TextBlock\",\"text\":\"User's Name\",\"wrap\":true},{\"type\":\"Input.Text\",\"placeholder\":\"First Name\",\"id\":\"firstName\",\"isRequired\":true,\"errorMessage\":\"please provide name\",\"label\":\"First Name\"},{\"type\":\"Input.Text\",\"placeholder\":\"Last Name\",\"id\":\"lastName\",\"isRequired\":true,\"errorMessage\":\"please provide name\",\"label\":\"Last Name\"}]}",
"UnsetAssignee": false,
"AssigneeId": null,
"UnsetSupportGroup": false,
"SupportGroupId": null,
"UnsetTeam": false,
"TeamId": null,
"GroupId": null,
"EscalationId": null,
"UnsetCategory": false,
"CategoryId": null,
"ImpactId": null,
"PriorityId": null,
"SourceId": null,
"StatusId": null,
"UrgencyId": null,
"LifecycleId": 2,
"IsArchived": false,
"UnsetTicketType": false,
"TicketTypeId": null,
"DueDate": null,
"RelativeDueDate": null,
"NoCustomForm": false,
"IsDefault": false,
"Id": 4,
"ModifiedDate": "2025-04-16T13:00:50.4776467Z",
"ModifiedById": 1,
"CreatedDate": "2025-01-23T18:27:24.1099932Z",
"CreatedById": 1,
"Guid": "90a91bb9-bba9-47b2-ac2c-351c47391647",
"IsDeleted": false
}
]
}
Tickets
GET
https://app.tikit.ai/api/RelatedTickets({{RelatedTicketId}})
Get Related Tickets By Id
This endpoint takes the
RelatedTicketsIdparameter to return a single related ticket record matching the specified Id.
Response Schema Hide
{
"type": "object",
"properties": {
"@odata.context": {
"type": "string",
"format": "uri"
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": "integer"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": "integer"
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
},
"SourceTicketId": {
"type": "integer"
},
"RelatedTicketId": {
"type": "integer"
},
"RelationshipTypeId": {
"type": "integer"
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/RelatedTickets({{RelatedTicketId}})"fetch("https://app.tikit.ai/api/RelatedTickets({{RelatedTicketId}})", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/RelatedTickets({{RelatedTicketId}})" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#RelatedTickets",
"value": [
{
"Id": 2,
"ModifiedDate": "2025-05-15T19:26:11.878164Z",
"ModifiedById": 1,
"CreatedDate": "2025-05-15T19:26:11.878164Z",
"CreatedById": 1,
"Guid": "a56f9329-fff0-4d5a-bd9d-84932d62fe2b",
"IsDeleted": false,
"SourceTicketId": 83,
"RelatedTicketId": 78,
"RelationshipTypeId": 2
}
]
}
GET
https://app.tikit.ai/api/RelatedTickets?$filter={{RelatedTicketFilterCriteria}}
Get Related Tickets with Filter
This endpoint returns ticket relationships that match the supplied
>
$filtercriteria. The filter syntax adheres to the OData specification. You can read more about OData filter strings here.
Example:
>
$filter=SourceTicketId eq 83
Response Schema Hide
{
"type": "object",
"properties": {
"@odata.context": {
"type": "string",
"format": "uri"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": "integer"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": "integer"
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
},
"SourceTicketId": {
"type": "integer"
},
"RelatedTicketId": {
"type": "integer"
},
"RelationshipTypeId": {
"type": "integer"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/RelatedTickets?$filter={{RelatedTicketFilterCriteria}}"fetch("https://app.tikit.ai/api/RelatedTickets?$filter={{RelatedTicketFilterCriteria}}", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/RelatedTickets?$filter={{RelatedTicketFilterCriteria}}" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#RelatedTickets",
"value": [
{
"Id": 2,
"ModifiedDate": "2025-05-15T19:26:11.878164Z",
"ModifiedById": 1,
"CreatedDate": "2025-05-15T19:26:11.878164Z",
"CreatedById": 1,
"Guid": "a56f9329-fff0-4d5a-bd9d-84932d62fe2b",
"IsDeleted": false,
"SourceTicketId": 83,
"RelatedTicketId": 78,
"RelationshipTypeId": 2
}
]
}
GET
https://app.tikit.ai/api/RelatedTickets
Get Related Tickets
This endpoint, with no filter criteria or any other parameters, will return an array of all ticket relationships and properties.
Response Schema Hide
{
"type": "object",
"properties": {
"@odata.context": {
"type": "string",
"format": "uri"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": "integer"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": "integer"
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
},
"SourceTicketId": {
"type": "integer"
},
"RelatedTicketId": {
"type": "integer"
},
"RelationshipTypeId": {
"type": "integer"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/RelatedTickets"
fetch("https://app.tikit.ai/api/RelatedTickets", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/RelatedTickets" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#RelatedTickets",
"value": [
{
"Id": 1,
"ModifiedDate": "2025-02-25T15:45:22.8292585Z",
"ModifiedById": 1,
"CreatedDate": "2025-02-25T15:45:22.8292585Z",
"CreatedById": 1,
"Guid": "e0f501b7-e96d-45e4-a16c-b4d1d67d66c9",
"IsDeleted": false,
"SourceTicketId": 56,
"RelatedTicketId": 57,
"RelationshipTypeId": 2
},
{
"Id": 2,
"ModifiedDate": "2025-05-15T19:26:11.878164Z",
"ModifiedById": 1,
"CreatedDate": "2025-05-15T19:26:11.878164Z",
"CreatedById": 1,
"Guid": "a56f9329-fff0-4d5a-bd9d-84932d62fe2b",
"IsDeleted": false,
"SourceTicketId": 83,
"RelatedTicketId": 78,
"RelationshipTypeId": 2
}
]
}
GET
https://app.tikit.ai/api/TicketCollaborator
Get Ticket Collaborators
This endpoint, with no filter criteria or any other parameters, will return an array of all ticket collaborators and properties.
Response Schema Hide
{
"type": "object",
"properties": {
"@odata.context": {
"type": "string",
"format": "uri"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"PlatformUserId": {
"type": "integer"
},
"TicketId": {
"type": "integer"
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": "integer"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": "integer"
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/TicketCollaborator"
fetch("https://app.tikit.ai/api/TicketCollaborator", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/TicketCollaborator" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://platformapp-07.azurewebsites.net/api/$metadata#TicketCollaborator",
"value": [
{
"PlatformUserId": 2,
"TicketId": 8,
"Id": 1,
"ModifiedDate": "2025-02-28T21:27:12.2294701Z",
"ModifiedById": 1,
"CreatedDate": "2025-02-28T21:27:12.2294701Z",
"CreatedById": 1,
"Guid": "bf808164-9e3e-4c81-ae36-41bef91c2b2c",
"IsDeleted": false
},
{
"PlatformUserId": 2,
"TicketId": 79,
"Id": 4,
"ModifiedDate": "2025-04-24T14:09:25.7393109Z",
"ModifiedById": 1,
"CreatedDate": "2025-04-24T14:09:25.7393109Z",
"CreatedById": 1,
"Guid": "d7ea4894-a96b-4287-b7d7-9c5747245f1b",
"IsDeleted": false
},
{
"PlatformUserId": 2,
"TicketId": 80,
"Id": 5,
"ModifiedDate": "2025-04-24T14:15:13.4398586Z",
"ModifiedById": 1,
"CreatedDate": "2025-04-24T14:15:13.4398586Z",
"CreatedById": 1,
"Guid": "98a40fd8-ff42-441f-b377-9fc243183578",
"IsDeleted": false
},
{
"PlatformUserId": 2,
"TicketId": 82,
"Id": 7,
"ModifiedDate": "2025-05-05T17:59:41.5208263Z",
"ModifiedById": 1,
"CreatedDate": "2025-05-05T17:59:41.5208263Z",
"CreatedById": 1,
"Guid": "4d0c77df-c84b-42d8-ad16-61fc98083b0d",
"IsDeleted": false
},
{
"PlatformUserId": 2,
"TicketId": 83,
"Id": 8,
"ModifiedDate": "2025-05-05T18:01:26.7482268Z",
"ModifiedById": 1,
"CreatedDate": "2025-05-05T18:01:26.7482268Z",
"CreatedById": 1,
"Guid": "91bf1fed-b332-4a24-bcf7-dea1afcdc4c6",
"IsDeleted": false
},
{
"PlatformUserId": 2,
"TicketId": 84,
"Id": 9,
"ModifiedDate": "2025-05-09T18:39:00.5101281Z",
"ModifiedById": 1,
"CreatedDate": "2025-05-09T18:39:00.5101281Z",
"CreatedById": 1,
"Guid": "3745d761-13f1-4da8-91f6-18c42d134afa",
"IsDeleted": false
},
{
"PlatformUserId": 2,
"TicketId": 85,
"Id": 10,
"ModifiedDate": "2025-05-09T18:40:04.9141645Z",
"ModifiedById": 1,
"CreatedDate": "2025-05-09T18:40:04.9141645Z",
"CreatedById": 1,
"Guid": "cedfd557-a80a-4fda-9f6f-a1a2e4d636d0",
"IsDeleted": false
},
{
"PlatformUserId": 3,
"TicketId": 95,
"Id": 11,
"ModifiedDate": "2025-05-15T19:08:32.8605639Z",
"ModifiedById": 1,
"CreatedDate": "2025-05-15T19:08:32.8605639Z",
"CreatedById": 1,
"Guid": "f5d6fdbb-a330-4834-9153-de7dd95a3fee",
"IsDeleted": false
}
]
}
GET
https://app.tikit.ai/api/Ticket({{TicketId}})
Get Ticket By Id
This endpoint takes the
TicketIdparameter to return a single ticket matching the specified Id.
Response Schema Hide
{
"type": "object",
"properties": {
"@odata.context": {
"type": "string",
"format": "uri"
},
"RequesterId": {
"type": "integer"
},
"Title": {
"type": "string"
},
"Closed": {
"type": "boolean"
},
"IsMerged": {
"type": "boolean"
},
"DueDate": {
"type": [
"string"
],
"format": "date-time"
},
"ResolutionDate": {
"type": [
"string"
],
"format": "date-time"
},
"Description": {
"type": [
"string"
]
},
"ReactivatedCount": {
"type": "integer"
},
"SurveyId": {
"type": [
"integer"
]
},
"AssigneeId": {
"type": "integer"
},
"SupportGroupId": {
"type": "integer"
},
"TeamId": {
"type": "integer"
},
"GroupId": {
"type": [
"integer"
]
},
"EscalationId": {
"type": [
"integer"
]
},
"CategoryId": {
"type": "integer"
},
"ImpactId": {
"type": [
"integer"
]
},
"PriorityId": {
"type": "integer"
},
"SourceId": {
"type": "integer"
},
"EmailResponseId": {
"type": [
"integer"
]
},
"Referrer": {
"type": [
"string"
]
},
"StatusId": {
"type": "integer"
},
"UrgencyId": {
"type": [
"integer"
]
},
"TriageConversationId": {
"type": "string"
},
"TriageActivityId": {
"type": "string"
},
"LinkToMessage": {
"type": "string"
},
"TemplateId": {
"type": [
"integer"
]
},
"CardTemplateJson": {
"type": [
"string"
]
},
"CardAnswerJson": {
"type": [
"string"
]
},
"TicketTypeId": {
"type": "integer"
},
"TicketLifecycleId": {
"type": [
"integer"
]
},
"ExternalId": {
"type": [
"string"
]
},
"FirstAssignmentDate": {
"type": [
"string"
],
"format": "date-time"
},
"FirstPrivateAgentComment": {
"type": [
"string"
]
},
"FirstAgentComment": {
"type": [
"string"
]
},
"FirstRequesterComment": {
"type": [
"string"
]
},
"ResolutionId": {
"type": [
"integer"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": "integer"
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/Ticket({{TicketId}})"fetch("https://app.tikit.ai/api/Ticket({{TicketId}})", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/Ticket({{TicketId}})" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#Ticket",
"RequesterId": 2,
"Title": "Needs a password reset",
"Closed": true,
"IsMerged": false,
"DueDate": null,
"ResolutionDate": "2024-10-08T07:00:02.3191793Z",
"Description": null,
"ReactivatedCount": 0,
"SurveyId": null,
"AssigneeId": 1,
"SupportGroupId": 5,
"TeamId": 1,
"GroupId": null,
"EscalationId": null,
"CategoryId": 3,
"ImpactId": null,
"PriorityId": 11,
"SourceId": 26,
"EmailResponseId": null,
"Referrer": null,
"StatusId": 19,
"UrgencyId": null,
"TriageConversationId": "19:ad5864652a104a4abd1837d08bc48daf@thread.tacv2;messageid=1721582424007",
"TriageActivityId": "1728582424007",
"LinkToMessage": "",
"TemplateId": null,
"CardTemplateJson": null,
"CardAnswerJson": null,
"TicketTypeId": 28,
"TicketLifecycleId": null,
"ExternalId": null,
"FirstAssignmentDate": null,
"FirstPrivateAgentComment": null,
"FirstAgentComment": null,
"FirstRequesterComment": null,
"ResolutionId": null,
"Id": 5,
"ModifiedDate": "2024-10-12T00:55:28.3008413Z",
"ModifiedById": null,
"CreatedDate": "2024-03-12T14:57:13.3915448Z",
"CreatedById": 1,
"Guid": "3a126393-324d-4abe-8255-dc77128c8ec5",
"IsDeleted": false
}
GET
https://app.tikit.ai/api/Ticket({{TicketId}})?$expand={{ExpandTicketProperty}}
Get Tickets with Expand
This endpoint takes the
>
>
>
ExpandTicketPropertyparameter to expand and return the included object properties for the returned tickets, along with the ticket properties. You can optionally include additional OData filters. The filter syntax adheres to the OData specification. You can read more about OData filter strings here.
Expandable Properties:
Requester, Survey, RelatedTickets,Assignee, SupportGroup, Team, Group, Escalation, Category, Impact, Priority, Source, Status, Urgency, AffectedItems, Comments, FileUploads, Tags, TicketApprovals, FileAttachments, TicketSlas, TicketTasks, AffectedUsers, TicketCollaborators, Metadata, Template, TicketType, TicketLifecycle, TicketCollaborators, Resolution
Examples:
>
$expand=\*
>
$expand=Tags
>
$expand=Requester,SupportGroup
Response Schema Hide
{
"type": "object",
"properties": {
"@odata.context": {
"type": "string",
"format": "uri"
},
"RequesterId": {
"type": "integer"
},
"Title": {
"type": "string"
},
"Closed": {
"type": "boolean"
},
"IsMerged": {
"type": "boolean"
},
"DueDate": {
"type": [
"string"
],
"format": "date-time"
},
"ResolutionDate": {
"type": "string",
"format": "date-time"
},
"Description": {
"type": [
"string"
]
},
"ReactivatedCount": {
"type": "integer"
},
"SurveyId": {
"type": [
"integer"
]
},
"AssigneeId": {
"type": [
"integer"
]
},
"SupportGroupId": {
"type": "integer"
},
"TeamId": {
"type": "integer"
},
"GroupId": {
"type": [
"integer"
]
},
"EscalationId": {
"type": "integer"
},
"CategoryId": {
"type": "integer"
},
"ImpactId": {
"type": "integer"
},
"PriorityId": {
"type": "integer"
},
"SourceId": {
"type": "integer"
},
"EmailResponseId": {
"type": [
"integer"
]
},
"Referrer": {
"type": [
"string"
]
},
"StatusId": {
"type": "integer"
},
"UrgencyId": {
"type": "integer"
},
"TriageConversationId": {
"type": "string"
},
"TriageActivityId": {
"type": "string"
},
"LinkToMessage": {
"type": "string"
},
"TemplateId": {
"type": "integer"
},
"CardTemplateJson": {
"type": "string"
},
"CardAnswerJson": {
"type": "string"
},
"TicketTypeId": {
"type": "integer"
},
"TicketLifecycleId": {
"type": [
"integer"
]
},
"ExternalId": {
"type": [
"string"
]
},
"FirstAssignmentDate": {
"type": [
"string"
],
"format": "date-time"
},
"FirstPrivateAgentComment": {
"type": [
"string"
],
"format": "date-time"
},
"FirstAgentComment": {
"type": [
"string"
],
"format": "date-time"
},
"FirstRequesterComment": {
"type": [
"string"
],
"format": "date-time"
},
"ResolutionId": {
"type": "integer"
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
},
"Requester": {
"type": "object",
"properties": {
"UserName": {
"type": "string"
},
"AadObjectId": {
"type": "string"
},
"Salutation": {
"type": [
"string"
]
},
"GivenName": {
"type": "string"
},
"MiddleName": {
"type": [
"string"
]
},
"FamilyName": {
"type": "string"
},
"Email": {
"type": "string",
"format": "email"
},
"PhoneNumber": {
"type": [
"string"
]
},
"MobilePhone": {
"type": [
"string"
]
},
"ServiceUrl": {
"type": [
"string"
]
},
"JobTitle": {
"type": [
"string"
]
},
"Department": {
"type": [
"string"
]
},
"CompanyName": {
"type": [
"string"
]
},
"EmployeeId": {
"type": [
"string"
]
},
"StreetAddress": {
"type": [
"string"
]
},
"State": {
"type": [
"string"
]
},
"Country": {
"type": [
"string"
]
},
"Office": {
"type": [
"string"
]
},
"City": {
"type": [
"string"
]
},
"ZipCode": {
"type": [
"string"
]
},
"OfficePhone": {
"type": "string"
},
"BlockSignIn": {
"type": "boolean"
},
"IsExternalUser": {
"type": "boolean"
},
"Type": {
"type": [
"string"
]
},
"Notes": {
"type": [
"string"
]
},
"TeamsUserId": {
"type": "string"
},
"HelpTeamsUserId": {
"type": [
"string"
]
},
"TVATeamsUserId": {
"type": "string"
},
"TeamsTimeZoneName": {
"type": "string"
},
"UserLocale": {
"type": "string"
},
"DisplayName": {
"type": "string"
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
},
"FullName": {
"type": "string"
}
}
},
"Survey": {
"type": [
"object"
]
},
"RelatedTickets": {
"type": "array"
},
"Assignee": {
"type": [
"object"
]
},
"SupportGroup": {
"type": "object",
"properties": {
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
},
"Name": {
"type": "string"
},
"Description": {
"type": "string"
},
"TeamsChannelId": {
"type": "string"
},
"TeamsAadObjectId": {
"type": "string"
},
"ApplicationRoleId": {
"type": [
"integer"
]
},
"IsArchived": {
"type": "boolean"
}
}
},
"Team": {
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"FriendlyName": {
"type": "string"
},
"Description": {
"type": "string"
},
"TeamsId": {
"type": "string"
},
"TeamsAadObjectId": {
"type": "string"
},
"TeamsChannelId": {
"type": "string"
},
"TeamsChannelName": {
"type": "string"
},
"IsDefault": {
"type": "boolean"
},
"EmailAddress": {
"type": "string"
},
"ClientState": {
"type": "string"
},
"ExpirationDate": {
"type": "string",
"format": "date-time"
},
"UserId": {
"type": "string"
},
"SubscriptionId": {
"type": "string"
},
"UseTicketDeflection": {
"type": "boolean"
},
"DefaultLocale": {
"type": "string"
},
"EnableMultiDepartmentPicker": {
"type": "boolean"
},
"MultiDepartmentPickerMessage": {
"type": "string"
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
},
"Group": {
"type": [
"object"
]
},
"Escalation": {
"type": "object",
"properties": {
"Value": {
"type": "string"
},
"Position": {
"type": "integer"
},
"IsArchived": {
"type": "boolean"
},
"IsDefault": {
"type": "boolean"
},
"IsSystem": {
"type": "boolean"
},
"ParentId": {
"type": [
"integer"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
},
"Category": {
"type": "object",
"properties": {
"Value": {
"type": "string"
},
"Position": {
"type": "integer"
},
"IsArchived": {
"type": "boolean"
},
"IsDefault": {
"type": "boolean"
},
"IsSystem": {
"type": "boolean"
},
"ParentId": {
"type": [
"integer"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
},
"Impact": {
"type": "object",
"properties": {
"Value": {
"type": "string"
},
"Position": {
"type": "integer"
},
"IsArchived": {
"type": "boolean"
},
"IsDefault": {
"type": "boolean"
},
"IsSystem": {
"type": "boolean"
},
"ParentId": {
"type": [
"integer"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
},
"Priority": {
"type": "object",
"properties": {
"Value": {
"type": "string"
},
"Position": {
"type": "integer"
},
"IsArchived": {
"type": "boolean"
},
"IsDefault": {
"type": "boolean"
},
"IsSystem": {
"type": "boolean"
},
"ParentId": {
"type": [
"integer"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
},
"Source": {
"type": "object",
"properties": {
"Value": {
"type": "string"
},
"Position": {
"type": "integer"
},
"IsArchived": {
"type": "boolean"
},
"IsDefault": {
"type": "boolean"
},
"IsSystem": {
"type": "boolean"
},
"ParentId": {
"type": [
"integer"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
},
"Status": {
"type": "object",
"properties": {
"Value": {
"type": "string"
},
"Position": {
"type": "integer"
},
"IsArchived": {
"type": "boolean"
},
"IsDefault": {
"type": "boolean"
},
"IsSystem": {
"type": "boolean"
},
"ParentId": {
"type": [
"integer"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
},
"Urgency": {
"type": "object",
"properties": {
"Value": {
"type": "string"
},
"Position": {
"type": "integer"
},
"IsArchived": {
"type": "boolean"
},
"IsDefault": {
"type": "boolean"
},
"IsSystem": {
"type": "boolean"
},
"ParentId": {
"type": [
"integer"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
},
"AffectedItems": {
"type": "array"
},
"Comments": {
"type": "array"
},
"FileUploads": {
"type": "array"
},
"Tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
},
"Name": {
"type": "string"
}
}
}
},
"TicketApprovals": {
"type": "array"
},
"FileAttachments": {
"type": "array"
},
"Template": {
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"Description": {
"type": "string"
},
"CardResponseJson": {
"type": "string"
},
"UnsetAssignee": {
"type": "boolean"
},
"AssigneeId": {
"type": [
"integer"
]
},
"UnsetSupportGroup": {
"type": "boolean"
},
"SupportGroupId": {
"type": [
"integer"
]
},
"UnsetTeam": {
"type": "boolean"
},
"TeamId": {
"type": [
"integer"
]
},
"GroupId": {
"type": [
"integer"
]
},
"EscalationId": {
"type": [
"integer"
]
},
"UnsetCategory": {
"type": "boolean"
},
"CategoryId": {
"type": [
"integer"
]
},
"ImpactId": {
"type": [
"integer"
]
},
"PriorityId": {
"type": [
"integer"
]
},
"SourceId": {
"type": [
"integer"
]
},
"StatusId": {
"type": [
"integer"
]
},
"UrgencyId": {
"type": [
"integer"
]
},
"LifecycleId": {
"type": [
"integer"
]
},
"IsArchived": {
"type": "boolean"
},
"UnsetTicketType": {
"type": "boolean"
},
"TicketTypeId": {
"type": "integer"
},
"DueDate": {
"type": [
"string"
],
"format": "date-time"
},
"RelativeDueDate": {
"type": [
"string"
]
},
"NoCustomForm": {
"type": "boolean"
},
"IsDefault": {
"type": "boolean"
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
},
"TicketType": {
"type": "object",
"properties": {
"Value": {
"type": "string"
},
"Position": {
"type": "integer"
},
"IsArchived": {
"type": "boolean"
},
"IsDefault": {
"type": "boolean"
},
"IsSystem": {
"type": "boolean"
},
"ParentId": {
"type": [
"integer"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
},
"TicketSlas": {
"type": "array"
},
"TicketTasks": {
"type": "array"
},
"TicketLifecycle": {
"type": [
"object"
]
},
"AffectedUsers": {
"type": "array"
},
"TicketCollaborators": {
"type": "array",
"items": {
"type": "object",
"properties": {
"PlatformUserId": {
"type": "integer"
},
"TicketId": {
"type": "integer"
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
},
"Metadata": {
"type": "array"
},
"Resolution": {
"type": "object",
"properties": {
"Note": {
"type": "string"
},
"InternalNote": {
"type": "string"
},
"DraftKB": {
"type": "boolean"
},
"ResolutionCategoryId": {
"type": "integer"
},
"AnswerId": {
"type": [
"integer"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": "integer"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": "integer"
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/Ticket({{TicketId}})?$expand={{ExpandTicketProperty}}"fetch("https://app.tikit.ai/api/Ticket({{TicketId}})?$expand={{ExpandTicketProperty}}", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/Ticket({{TicketId}})?$expand={{ExpandTicketProperty}}" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://platformapp-04.azurewebsites.net/api/$metadata#Ticket(Requester(),Survey(),RelatedTickets(),Assignee(),SupportGroup(),Team(),Group(),Escalation(),Category(),Impact(),Priority(),Source(),Status(),Urgency(),AffectedItems(),Comments(),FileUploads(),Tags(),TicketApprovals(),FileAttachments(),Template(),TicketType(),TicketSlas(),TicketTasks(),TicketLifecycle(),AffectedUsers(),TicketCollaborators(),Metadata(),Resolution())/$entity",
"RequesterId": 1,
"Title": "Hardware Request",
"Closed": false,
"IsMerged": false,
"DueDate": null,
"ResolutionDate": "2025-05-27T19:02:26.0083346Z",
"Description": null,
"ReactivatedCount": 0,
"SurveyId": null,
"AssigneeId": null,
"SupportGroupId": 1,
"TeamId": 1,
"GroupId": null,
"EscalationId": 6,
"CategoryId": 69,
"ImpactId": 9,
"PriorityId": 11,
"SourceId": 23,
"EmailResponseId": null,
"Referrer": null,
"StatusId": 18,
"UrgencyId": 21,
"TriageConversationId": "19:c6bea6a2cbba4488a58e8a379f33b489@thread.tacv2;messageid=1748359166483",
"TriageActivityId": "1748359166483",
"LinkToMessage": "",
"TemplateId": 8,
"CardTemplateJson": "{\"$schema\":\"http://adaptivecards.io/schemas/adaptive-card.json\",\"type\":\"AdaptiveCard\",\"version\":\"1.4\",\"body\":[{\"type\":\"TextBlock\",\"text\":\"Hardware Request Form\",\"wrap\":true,\"id\":\"title\",\"fontType\":\"Default\",\"size\":\"ExtraLarge\",\"weight\":\"Bolder\",\"color\":\"Dark\",\"isSubtle\":false},{\"type\":\"Input.Text\",\"placeholder\":\"Reason for request\",\"isMultiline\":true,\"id\":\"justification\",\"label\":\"Justification\",\"separator\":true,\"isRequired\":true,\"errorMessage\":\"please enter a reason\"},{\"type\":\"Category\",\"id\":\"Ticket.Category\",\"displayLabel\":\"Hardware Request Type\",\"requireField\":true,\"dataSource\":\"1\",\"choices\":[{\"title\":\"-- Monitor\",\"value\":\"66\"},{\"title\":\"-- Keyboard\",\"value\":\"67\"},{\"title\":\"-- Mouse\",\"value\":\"68\"},{\"title\":\"-- Printer\",\"value\":\"69\"},{\"title\":\"-- Laptop\",\"value\":\"70\"},{\"title\":\"-- Desktop\",\"value\":\"71\"}]}]}",
"CardAnswerJson": "{\"justification\":\"need a new printer\",\"Ticket.Category\":\"69\"}",
"TicketTypeId": 59,
"TicketLifecycleId": null,
"ExternalId": null,
"FirstAssignmentDate": null,
"FirstPrivateAgentComment": null,
"FirstAgentComment": null,
"FirstRequesterComment": null,
"ResolutionId": 8,
"Id": 101,
"ModifiedDate": "2025-05-27T19:02:26.0088061Z",
"ModifiedById": null,
"CreatedDate": "2025-05-27T15:19:07.5097591Z",
"CreatedById": 1,
"Guid": "f3d7a12e-0762-4885-88db-ba7d687e4222",
"IsDeleted": false,
"Requester": {
"UserName": "john.doe@6pjybx.onmicrosoft.com",
"AadObjectId": "de1f0cfd-17dc-49b9-bd70-290187d15780",
"Salutation": null,
"GivenName": "John",
"MiddleName": null,
"FamilyName": "Doe",
"Email": "john.doe@6pjybx.onmicrosoft.com",
"PhoneNumber": null,
"MobilePhone": null,
"ServiceUrl": "https://smba.trafficmanager.net/amer/7f652225-5313-4c04-b777-92a78b67d819/",
"JobTitle": null,
"Department": null,
"CompanyName": null,
"EmployeeId": null,
"StreetAddress": null,
"State": null,
"Country": null,
"Office": null,
"City": null,
"ZipCode": null,
"OfficePhone": "16672989039",
"BlockSignIn": false,
"IsExternalUser": false,
"Type": null,
"Notes": null,
"TeamsUserId": "29:1bH1UqzlZSpKPfwrsQoKU-vX5zzLWTQOAZ0KBYpB8zhi514I_ftLcIRSukTgjd3at85J6SWZJCZAMMEgL_vA1qA",
"HelpTeamsUserId": null,
"TVATeamsUserId": "29:1ckGO7dRn7pztDLxgcu-mrJZmJF2nwVl9W0zh-Piuy6Ky4GkqEObvHZ3xyEtl8e5u_1n0B9fQfKqHTiaBf494Og",
"TeamsTimeZoneName": "Eastern Standard Time",
"UserLocale": "en-US",
"DisplayName": "John Doe",
"Id": 1,
"ModifiedDate": "2025-03-25T18:01:40.7520659Z",
"ModifiedById": 1,
"CreatedDate": "2024-05-15T19:43:52.4373635Z",
"CreatedById": null,
"Guid": "de1f0cfd-17dc-49b9-bd70-290187d15780",
"IsDeleted": false,
"FullName": "John Doe"
},
"Survey": null,
"RelatedTickets": [],
"Assignee": null,
"SupportGroup": {
"Id": 1,
"ModifiedDate": "2024-07-05T20:06:15.115808Z",
"ModifiedById": 1,
"CreatedDate": "2024-05-15T19:53:36.4207335Z",
"CreatedById": 1,
"Guid": "6048450a-f75f-43a5-b58b-f7925a45b56c",
"IsDeleted": false,
"Name": "🎟️ Service Desk",
"Description": "Tech Support",
"TeamsChannelId": "19:c6bea6a2cbba4488a58e8a379f33b489@thread.tacv2",
"TeamsAadObjectId": "507f85f3-a432-4341-9929-7b0d891e8c42",
"ApplicationRoleId": null,
"IsArchived": false
},
"Team": {
"Name": "Support",
"FriendlyName": "Support",
"Description": "",
"TeamsId": "19:X397NQ8IUT33nm_kjA0JtNWBNuD8EOLU7A_kDoDGk-c1@thread.tacv2",
"TeamsAadObjectId": "507f85f3-a432-4341-9929-7b0d891e8c42",
"TeamsChannelId": "19:c6bea6a2cbba4488a58e8a379f33b489@thread.tacv2",
"TeamsChannelName": "🎟️ Service Desk",
"IsDefault": true,
"EmailAddress": "supportdesk@6pjybx.onmicrosoft.com",
"ClientState": "342666b2-c6e3-43c5-b420-c2c7c46c02e9",
"ExpirationDate": "2025-05-29T09:37:05.1861579Z",
"UserId": "8dd827e9-158d-4004-aaa0-5bc051bc14c8",
"SubscriptionId": "b67901e8-9078-4511-b3ad-1d5fbb1a9bdb",
"UseTicketDeflection": true,
"DefaultLocale": "en-US",
"EnableMultiDepartmentPicker": true,
"MultiDepartmentPickerMessage": "",
"Id": 1,
"ModifiedDate": "2025-05-28T10:37:06.4378691Z",
"ModifiedById": null,
"CreatedDate": "2024-05-15T19:53:35.7986309Z",
"CreatedById": 1,
"Guid": "abace62b-b548-4edd-afdc-4700d5ae5822",
"IsDeleted": false
},
"Group": null,
"Escalation": {
"Value": "Escalation 1",
"Position": 0,
"IsArchived": false,
"IsDefault": false,
"IsSystem": false,
"ParentId": null,
"Id": 6,
"ModifiedDate": "2020-12-22T22:18:11.1849388Z",
"ModifiedById": null,
"CreatedDate": "2020-12-22T22:18:11.1849388Z",
"CreatedById": null,
"Guid": "607e900c-e44d-4723-a202-8171c5163e35",
"IsDeleted": false
},
"Category": {
"Value": "Printer",
"Position": 4,
"IsArchived": false,
"IsDefault": false,
"IsSystem": false,
"ParentId": 65,
"Id": 69,
"ModifiedDate": "2025-05-27T00:50:00.3915476Z",
"ModifiedById": 1,
"CreatedDate": "2025-05-27T00:49:48.7881573Z",
"CreatedById": 1,
"Guid": "0c815189-45cd-4484-8603-7c2605b54c61",
"IsDeleted": false
},
"Impact": {
"Value": "Medium",
"Position": 0,
"IsArchived": false,
"IsDefault": true,
"IsSystem": false,
"ParentId": null,
"Id": 9,
"ModifiedDate": "2020-12-22T22:18:11.1849388Z",
"ModifiedById": null,
"CreatedDate": "2020-12-22T22:18:11.1849388Z",
"CreatedById": null,
"Guid": "ead0b520-892b-4941-8b5e-3c4aebea2e0c",
"IsDeleted": false
},
"Priority": {
"Value": "1 (High)",
"Position": 0,
"IsArchived": false,
"IsDefault": false,
"IsSystem": false,
"ParentId": null,
"Id": 11,
"ModifiedDate": "2024-09-06T18:55:41.2543411Z",
"ModifiedById": 1,
"CreatedDate": "2020-12-22T22:18:11.1849388Z",
"CreatedById": null,
"Guid": "cc62d4de-96fe-40be-97fe-15588c31ac47",
"IsDeleted": false
},
"Source": {
"Value": "Teams",
"Position": 0,
"IsArchived": false,
"IsDefault": true,
"IsSystem": false,
"ParentId": null,
"Id": 23,
"ModifiedDate": "2021-03-31T01:36:26.5128577Z",
"ModifiedById": null,
"CreatedDate": "2021-03-31T01:36:26.5128577Z",
"CreatedById": null,
"Guid": "69641770-8803-4f04-a272-acac9c60246e",
"IsDeleted": false
},
"Status": {
"Value": "Resolved",
"Position": 4,
"IsArchived": false,
"IsDefault": false,
"IsSystem": true,
"ParentId": null,
"Id": 18,
"ModifiedDate": "2025-01-27T19:32:41.1933867Z",
"ModifiedById": 1,
"CreatedDate": "2020-12-22T22:18:11.1849388Z",
"CreatedById": null,
"Guid": "3018134d-1ca5-4fb6-a079-dc05959f3acc",
"IsDeleted": false
},
"Urgency": {
"Value": "Medium",
"Position": 0,
"IsArchived": false,
"IsDefault": true,
"IsSystem": false,
"ParentId": null,
"Id": 21,
"ModifiedDate": "2020-12-22T22:18:11.1849388Z",
"ModifiedById": null,
"CreatedDate": "2020-12-22T22:18:11.1849388Z",
"CreatedById": null,
"Guid": "87fb7c07-8242-41cb-aea0-a75a5fa4bdfb",
"IsDeleted": false
},
"AffectedItems": [],
"Comments": [],
"FileUploads": [],
"Tags": [
{
"Id": 1,
"ModifiedDate": "2025-05-26T17:55:08.0117657Z",
"ModifiedById": 1,
"CreatedDate": "2024-10-02T12:26:37.9900827Z",
"CreatedById": 1,
"Guid": "c0005fa6-6080-4873-804c-107883badd88",
"IsDeleted": false,
"Name": "VIP"
}
],
"TicketApprovals": [],
"FileAttachments": [],
"Template": {
"Name": "Hardware Request",
"Description": "Request PC Hardware",
"CardResponseJson": "{\"$schema\":\"http://adaptivecards.io/schemas/adaptive-card.json\",\"type\":\"AdaptiveCard\",\"version\":\"1.4\",\"body\":[{\"type\":\"TextBlock\",\"text\":\"Hardware Request Form\",\"wrap\":true,\"id\":\"title\",\"fontType\":\"Default\",\"size\":\"ExtraLarge\",\"weight\":\"Bolder\",\"color\":\"Dark\",\"isSubtle\":false},{\"type\":\"Input.Text\",\"placeholder\":\"Reason for request\",\"isMultiline\":true,\"id\":\"justification\",\"label\":\"Justification\",\"separator\":true,\"isRequired\":true,\"errorMessage\":\"please enter a reason\"},{\"type\":\"Category\",\"id\":\"Ticket.Category\",\"displayLabel\":\"Hardware Request Type\",\"requireField\":true,\"dataSource\":\"1\"}]}",
"UnsetAssignee": false,
"AssigneeId": null,
"UnsetSupportGroup": false,
"SupportGroupId": null,
"UnsetTeam": false,
"TeamId": null,
"GroupId": null,
"EscalationId": null,
"UnsetCategory": false,
"CategoryId": null,
"ImpactId": null,
"PriorityId": null,
"SourceId": null,
"StatusId": null,
"UrgencyId": null,
"LifecycleId": null,
"IsArchived": false,
"UnsetTicketType": false,
"TicketTypeId": 59,
"DueDate": null,
"RelativeDueDate": null,
"NoCustomForm": false,
"IsDefault": false,
"Id": 8,
"ModifiedDate": "2025-05-27T14:26:20.5359651Z",
"ModifiedById": 1,
"CreatedDate": "2025-04-25T18:01:12.6882985Z",
"CreatedById": 1,
"Guid": "cab39628-08d1-4a7b-b615-b1e441f58ecd",
"IsDeleted": false
},
"TicketType": {
"Value": "Request",
"Position": 2,
"IsArchived": false,
"IsDefault": false,
"IsSystem": false,
"ParentId": 29,
"Id": 59,
"ModifiedDate": "2025-05-27T02:08:02.2884673Z",
"ModifiedById": 1,
"CreatedDate": "2025-05-26T16:04:56.2682901Z",
"CreatedById": 1,
"Guid": "d361c99b-4ec8-46d8-be6f-a757da3d847d",
"IsDeleted": false
},
"TicketSlas": [],
"TicketTasks": [],
"TicketLifecycle": null,
"AffectedUsers": [],
"TicketCollaborators": [
{
"PlatformUserId": 3,
"TicketId": 101,
"Id": 22,
"ModifiedDate": "2025-05-27T15:23:35.1350128Z",
"ModifiedById": null,
"CreatedDate": "2025-05-27T15:23:35.1350128Z",
"CreatedById": null,
"Guid": "02ebacf7-9884-4900-a2b0-c43ad4b273d8",
"IsDeleted": false
},
{
"PlatformUserId": 4,
"TicketId": 101,
"Id": 23,
"ModifiedDate": "2025-05-27T15:23:35.1350128Z",
"ModifiedById": null,
"CreatedDate": "2025-05-27T15:23:35.1350128Z",
"CreatedById": null,
"Guid": "6a18014d-2b81-493b-94c7-0bc5954eb277",
"IsDeleted": false
}
],
"Metadata": [],
"Resolution": {
"Note": "Resolved with upgrade",
"InternalNote": "",
"DraftKB": false,
"ResolutionCategoryId": 45,
"AnswerId": null,
"Id": 8,
"ModifiedDate": "2025-05-27T19:02:23.7592148Z",
"ModifiedById": 1,
"CreatedDate": "2025-05-27T19:02:23.7592148Z",
"CreatedById": 1,
"Guid": "91c0867b-8fac-4e37-b98c-30fe64156063",
"IsDeleted": false
}
}
GET
https://app.tikit.ai/api/Ticket?$filter={{TicketFilterCriteria}}
Get Tickets with Filter
This endpoint returns tickets that match the supplied
>
>
$filtercriteria. The filter syntax adheres to the OData specification. You can read more about OData filter strings here.
Examples:
>
$filter=Id gt 13
>
$filter=contains(Title, 'help')
Response Schema Hide
{
"type": "object",
"properties": {
"@odata.context": {
"type": "string",
"format": "uri"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"RequesterId": {
"type": "integer"
},
"Title": {
"type": "string"
},
"Closed": {
"type": "boolean"
},
"IsMerged": {
"type": "boolean"
},
"DueDate": {
"type": [
"string"
],
"format": "date-time"
},
"ResolutionDate": {
"type": [
"string"
],
"format": "date-time"
},
"Description": {
"type": [
"string"
]
},
"ReactivatedCount": {
"type": "integer"
},
"SurveyId": {
"type": [
"integer"
]
},
"AssigneeId": {
"type": "integer"
},
"SupportGroupId": {
"type": "integer"
},
"TeamId": {
"type": "integer"
},
"GroupId": {
"type": [
"integer"
]
},
"EscalationId": {
"type": [
"integer"
]
},
"CategoryId": {
"type": "integer"
},
"ImpactId": {
"type": [
"integer"
]
},
"PriorityId": {
"type": "integer"
},
"SourceId": {
"type": "integer"
},
"EmailResponseId": {
"type": [
"integer"
]
},
"Referrer": {
"type": [
"string"
]
},
"StatusId": {
"type": "integer"
},
"UrgencyId": {
"type": [
"integer"
]
},
"TriageConversationId": {
"type": "string"
},
"TriageActivityId": {
"type": "string"
},
"LinkToMessage": {
"type": "string"
},
"TemplateId": {
"type": [
"integer"
]
},
"CardTemplateJson": {
"type": [
"string"
]
},
"CardAnswerJson": {
"type": [
"string"
]
},
"TicketTypeId": {
"type": "integer"
},
"TicketLifecycleId": {
"type": [
"integer"
]
},
"ExternalId": {
"type": [
"string"
]
},
"FirstAssignmentDate": {
"type": [
"string"
],
"format": "date-time"
},
"FirstPrivateAgentComment": {
"type": [
"string"
]
},
"FirstAgentComment": {
"type": [
"string"
]
},
"FirstRequesterComment": {
"type": [
"string"
]
},
"ResolutionId": {
"type": [
"integer"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": "integer"
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/Ticket?$filter={{TicketFilterCriteria}}"fetch("https://app.tikit.ai/api/Ticket?$filter={{TicketFilterCriteria}}", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/Ticket?$filter={{TicketFilterCriteria}}" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#Ticket",
"value": [
{
"RequesterId": 2,
"Title": "Needs a password reset",
"Closed": true,
"IsMerged": false,
"DueDate": null,
"ResolutionDate": "2024-10-08T07:00:02.3191793Z",
"Description": null,
"ReactivatedCount": 0,
"SurveyId": null,
"AssigneeId": 1,
"SupportGroupId": 5,
"TeamId": 1,
"GroupId": null,
"EscalationId": null,
"CategoryId": 3,
"ImpactId": null,
"PriorityId": 11,
"SourceId": 26,
"EmailResponseId": null,
"Referrer": null,
"StatusId": 19,
"UrgencyId": null,
"TriageConversationId": "19:ad5864652a104a4abd1837d08bc48daf@thread.tacv2;messageid=1721582424007",
"TriageActivityId": "1728582424007",
"LinkToMessage": "",
"TemplateId": null,
"CardTemplateJson": null,
"CardAnswerJson": null,
"TicketTypeId": 28,
"TicketLifecycleId": null,
"ExternalId": null,
"FirstAssignmentDate": null,
"FirstPrivateAgentComment": null,
"FirstAgentComment": null,
"FirstRequesterComment": null,
"ResolutionId": null,
"Id": 5,
"ModifiedDate": "2024-10-12T00:55:28.3008413Z",
"ModifiedById": null,
"CreatedDate": "2024-03-12T14:57:13.3915448Z",
"CreatedById": 1,
"Guid": "3a126393-324d-4abe-8255-dc77128c8ec5",
"IsDeleted": false
}
]
}
GET
https://app.tikit.ai/api/Ticket
Get Tickets
This endpoint, with no filter criteria or any other parameters, will return an array of all tickets and properties.
Response Schema Hide
{
"type": "object",
"properties": {
"@odata.context": {
"type": "string",
"format": "uri"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"RequesterId": {
"type": "integer"
},
"Title": {
"type": "string"
},
"Closed": {
"type": "boolean"
},
"IsMerged": {
"type": "boolean"
},
"DueDate": {
"type": [
"string"
],
"format": "date-time"
},
"ResolutionDate": {
"type": [
"string"
],
"format": "date-time"
},
"Description": {
"type": [
"string"
]
},
"ReactivatedCount": {
"type": "integer"
},
"SurveyId": {
"type": [
"integer"
]
},
"AssigneeId": {
"type": "integer"
},
"SupportGroupId": {
"type": "integer"
},
"TeamId": {
"type": "integer"
},
"GroupId": {
"type": [
"integer"
]
},
"EscalationId": {
"type": [
"integer"
]
},
"CategoryId": {
"type": "integer"
},
"ImpactId": {
"type": [
"integer"
]
},
"PriorityId": {
"type": "integer"
},
"SourceId": {
"type": "integer"
},
"EmailResponseId": {
"type": [
"integer"
]
},
"Referrer": {
"type": [
"string"
]
},
"StatusId": {
"type": "integer"
},
"UrgencyId": {
"type": [
"integer"
]
},
"TriageConversationId": {
"type": "string"
},
"TriageActivityId": {
"type": "string"
},
"LinkToMessage": {
"type": "string"
},
"TemplateId": {
"type": [
"integer"
]
},
"CardTemplateJson": {
"type": [
"string"
]
},
"CardAnswerJson": {
"type": [
"string"
]
},
"TicketTypeId": {
"type": "integer"
},
"TicketLifecycleId": {
"type": [
"integer"
]
},
"ExternalId": {
"type": [
"string"
]
},
"FirstAssignmentDate": {
"type": [
"string"
],
"format": "date-time"
},
"FirstPrivateAgentComment": {
"type": [
"string"
]
},
"FirstAgentComment": {
"type": [
"string"
]
},
"FirstRequesterComment": {
"type": [
"string"
]
},
"ResolutionId": {
"type": [
"integer"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": "integer"
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/Ticket"
fetch("https://app.tikit.ai/api/Ticket", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/Ticket" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#Ticket",
"value": [
{
"RequesterId": 2,
"Title": "Needs a password reset",
"Closed": true,
"IsMerged": false,
"DueDate": null,
"ResolutionDate": "2024-10-08T07:00:02.3191793Z",
"Description": null,
"ReactivatedCount": 0,
"SurveyId": null,
"AssigneeId": 1,
"SupportGroupId": 5,
"TeamId": 1,
"GroupId": null,
"EscalationId": null,
"CategoryId": 3,
"ImpactId": null,
"PriorityId": 11,
"SourceId": 26,
"EmailResponseId": null,
"Referrer": null,
"StatusId": 19,
"UrgencyId": null,
"TriageConversationId": "19:ad5864652a104a4abd1837d08bc48daf@thread.tacv2;messageid=1721582424007",
"TriageActivityId": "1728582424007",
"LinkToMessage": "",
"TemplateId": null,
"CardTemplateJson": null,
"CardAnswerJson": null,
"TicketTypeId": 28,
"TicketLifecycleId": null,
"ExternalId": null,
"FirstAssignmentDate": null,
"FirstPrivateAgentComment": null,
"FirstAgentComment": null,
"FirstRequesterComment": null,
"ResolutionId": null,
"Id": 5,
"ModifiedDate": "2024-10-12T00:55:28.3008413Z",
"ModifiedById": null,
"CreatedDate": "2024-03-12T14:57:13.3915448Z",
"CreatedById": 1,
"Guid": "3a126393-324d-4abe-8255-dc77128c8ec5",
"IsDeleted": false
}
]
}
POST
https://app.tikit.ai/api/Ticket
Create Ticket
This endpoint is used to create a new ticket. The ticket properties should be passed as the JSON body payload.
-
-
-
-
-
-
-
-
Parameters
-
Title(string, required) - The user's username in email format
-
StatusId(integer, optional) - The unique status identifier of the ticket
-
CategoryId(integer, optional) - The unique category identifier of the ticket
-
PriorityId(integer, optional) - The unique priority identifier of the ticket
-
TeamId(integer, optional) - The unique team identifier of the ticket
-
TicketTypeId(integer, optional) - The unique ticket type identifier of the ticket
-
SupportGroupId(integer, optional) - The unique support group identifier of the ticket
-
RequesterId(integer, optional) - The unique requester identifier of the ticket
Response Schema Hide
{
"type": "object",
"properties": {
"@odata.context": {
"type": "string",
"format": "uri"
},
"RequesterId": {
"type": "integer"
},
"Title": {
"type": "string"
},
"Closed": {
"type": "boolean"
},
"IsMerged": {
"type": "boolean"
},
"DueDate": {
"type": [
"string"
],
"format": "date-time"
},
"ResolutionDate": {
"type": [
"string"
],
"format": "date-time"
},
"Description": {
"type": [
"string"
]
},
"ReactivatedCount": {
"type": "integer"
},
"SurveyId": {
"type": [
"integer"
]
},
"AssigneeId": {
"type": [
"integer"
]
},
"SupportGroupId": {
"type": "integer"
},
"TeamId": {
"type": "integer"
},
"GroupId": {
"type": [
"integer"
]
},
"EscalationId": {
"type": [
"integer"
]
},
"CategoryId": {
"type": "integer"
},
"ImpactId": {
"type": [
"integer"
]
},
"PriorityId": {
"type": "integer"
},
"SourceId": {
"type": [
"integer"
]
},
"EmailResponseId": {
"type": [
"integer"
]
},
"Referrer": {
"type": [
"string"
]
},
"StatusId": {
"type": "integer"
},
"UrgencyId": {
"type": [
"integer"
]
},
"TriageConversationId": {
"type": [
"string"
]
},
"TriageActivityId": {
"type": [
"string"
]
},
"LinkToMessage": {
"type": [
"string"
]
},
"TemplateId": {
"type": [
"integer"
]
},
"CardTemplateJson": {
"type": [
"string"
]
},
"CardAnswerJson": {
"type": [
"string"
]
},
"TicketTypeId": {
"type": "integer"
},
"TicketLifecycleId": {
"type": [
"integer"
]
},
"ExternalId": {
"type": [
"string"
]
},
"FirstAssignmentDate": {
"type": [
"string"
],
"format": "date-time"
},
"FirstPrivateAgentComment": {
"type": [
"string"
]
},
"FirstAgentComment": {
"type": [
"string"
]
},
"FirstRequesterComment": {
"type": [
"string"
]
},
"ResolutionId": {
"type": [
"integer"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": "integer"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": "integer"
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
}
}
}
Code Samples
curl -X POST -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/Ticket"
fetch("https://app.tikit.ai/api/Ticket", { method: "POST", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/Ticket" -Method POST -Headers @{Authorization = "Bearer <token>"}Request Example
{
"Title": "I need help",
"StatusId": 16,
"CategoryId": 1,
"PriorityId": 12,
"TeamId": 1,
"TicketTypeId": 28,
"SupportGroupId": 1,
"RequesterId": 4
}
Try it out
PendingHide
Example Hide
{
"@odata.context": "https://platformapp-07.azurewebsites.net/api/$metadata#Ticket/$entity",
"RequesterId": 4,
"Title": "I need help",
"Closed": false,
"IsMerged": false,
"DueDate": null,
"ResolutionDate": null,
"Description": null,
"ReactivatedCount": 0,
"SurveyId": null,
"AssigneeId": null,
"SupportGroupId": 1,
"TeamId": 1,
"GroupId": null,
"EscalationId": null,
"CategoryId": 1,
"ImpactId": null,
"PriorityId": 12,
"SourceId": null,
"EmailResponseId": null,
"Referrer": null,
"StatusId": 16,
"UrgencyId": null,
"TriageConversationId": null,
"TriageActivityId": null,
"LinkToMessage": null,
"TemplateId": null,
"CardTemplateJson": null,
"CardAnswerJson": null,
"TicketTypeId": 28,
"TicketLifecycleId": null,
"ExternalId": null,
"FirstAssignmentDate": null,
"FirstPrivateAgentComment": null,
"FirstAgentComment": null,
"FirstRequesterComment": null,
"ResolutionId": null,
"Id": 94,
"ModifiedDate": "2025-05-15T18:41:59.5574655Z",
"ModifiedById": 1,
"CreatedDate": "2025-05-15T18:41:59.5574655Z",
"CreatedById": 1,
"Guid": "43fb626c-345e-40e7-beca-b7d97268dbb6",
"IsDeleted": false
}
Users
A collection of endpoints for managing Users.
GET
https://app.tikit.ai/api/PlatformUser({{UserId}})
Get User By Id
This endpoint takes the
UserIdparameter to return a single user matching the specified Id.
Response Schema Hide
{
"type": "object",
"properties": {
"@odata.context": {
"type": "string",
"format": "uri"
},
"UserName": {
"type": "string",
"format": "email"
},
"AadObjectId": {
"type": "string",
"format": "uuid"
},
"Salutation": {
"type": [
"string"
]
},
"GivenName": {
"type": [
"string"
]
},
"MiddleName": {
"type": [
"string"
]
},
"FamilyName": {
"type": [
"string"
]
},
"Email": {
"type": [
"string"
],
"format": "email"
},
"PhoneNumber": {
"type": [
"string"
]
},
"MobilePhone": {
"type": [
"string"
]
},
"ServiceUrl": {
"type": "string",
"format": "uri"
},
"JobTitle": {
"type": [
"string"
]
},
"Department": {
"type": [
"string"
]
},
"CompanyName": {
"type": [
"string"
]
},
"EmployeeId": {
"type": [
"string"
]
},
"StreetAddress": {
"type": [
"string"
]
},
"State": {
"type": [
"string"
]
},
"Country": {
"type": [
"string"
]
},
"Office": {
"type": [
"string"
]
},
"City": {
"type": [
"string"
]
},
"ZipCode": {
"type": [
"string"
]
},
"OfficePhone": {
"type": [
"string"
]
},
"BlockSignIn": {
"type": "boolean"
},
"IsExternalUser": {
"type": "boolean"
},
"Type": {
"type": [
"string"
]
},
"Notes": {
"type": [
"string"
]
},
"TeamsUserId": {
"type": [
"string"
]
},
"HelpTeamsUserId": {
"type": [
"string"
]
},
"TVATeamsUserId": {
"type": [
"string"
]
},
"TeamsTimeZoneName": {
"type": [
"string"
]
},
"UserLocale": {
"type": "string"
},
"DisplayName": {
"type": "string"
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
},
"FullName": {
"type": "string"
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/PlatformUser({{UserId}})"fetch("https://app.tikit.ai/api/PlatformUser({{UserId}})", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/PlatformUser({{UserId}})" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://platformapp-07.azurewebsites.net/api/$metadata#PlatformUser",
"UserName": "john.doe@example.com",
"AadObjectId": "a1b2c3d4-e5f6-7890-gh12-ijkl34567890",
"Salutation": null,
"GivenName": "John",
"MiddleName": null,
"FamilyName": "Doe",
"Email": "john.doe@example.com",
"PhoneNumber": null,
"MobilePhone": null,
"ServiceUrl": "https://smba.trafficmanager.net/amer/abcd1234-5678-9def-ghij-1234567890kl/",
"JobTitle": null,
"Department": null,
"CompanyName": null,
"EmployeeId": null,
"StreetAddress": null,
"State": null,
"Country": null,
"Office": null,
"City": null,
"ZipCode": null,
"OfficePhone": "12345678901",
"BlockSignIn": false,
"IsExternalUser": false,
"Type": null,
"Notes": null,
"TeamsUserId": "29:abcdefgH1iJklMnOPqrS01234stuvWxyzABCD5678EFGH",
"HelpTeamsUserId": null,
"TVATeamsUserId": "29:ijklmnopQRstuvXYZ1234567890abcdEFGHijklMNOPQR",
"TeamsTimeZoneName": "Central Standard Time",
"UserLocale": "en-US",
"DisplayName": "John Doe",
"Id": 2,
"ModifiedDate": "2025-04-03T21:26:19.3991113Z",
"ModifiedById": 2,
"CreatedDate": "2024-03-12T12:36:18.7789659Z",
"CreatedById": null,
"Guid": "a1b2c3d4-e5f6-7890-gh12-ijkl34567890",
"IsDeleted": false,
"FullName": "John Doe"
}
GET
https://app.tikit.ai/api/PlatformUser?$filter={{UserFilterCriteria}}
Get Users with Filter
This endpoint returns users who match the supplied
>
OR
> $filter=contains(UserName, 'joe')
$filtercriteria. The filter syntax adheres to the OData specification. You can read more about OData filter strings here.
Exmaple:
>
$filter=Id gt 13
OR
> $filter=contains(UserName, 'joe')
Response Schema Hide
{
"type": "object",
"properties": {
"@odata.context": {
"type": "string",
"format": "uri"
},
"UserName": {
"type": "string",
"format": "email"
},
"AadObjectId": {
"type": "string",
"format": "uuid"
},
"Salutation": {
"type": [
"string"
]
},
"GivenName": {
"type": [
"string"
]
},
"MiddleName": {
"type": [
"string"
]
},
"FamilyName": {
"type": [
"string"
]
},
"Email": {
"type": [
"string"
],
"format": "email"
},
"PhoneNumber": {
"type": [
"string"
]
},
"MobilePhone": {
"type": [
"string"
]
},
"ServiceUrl": {
"type": "string",
"format": "uri"
},
"JobTitle": {
"type": [
"string"
]
},
"Department": {
"type": [
"string"
]
},
"CompanyName": {
"type": [
"string"
]
},
"EmployeeId": {
"type": [
"string"
]
},
"StreetAddress": {
"type": [
"string"
]
},
"State": {
"type": [
"string"
]
},
"Country": {
"type": [
"string"
]
},
"Office": {
"type": [
"string"
]
},
"City": {
"type": [
"string"
]
},
"ZipCode": {
"type": [
"string"
]
},
"OfficePhone": {
"type": [
"string"
]
},
"BlockSignIn": {
"type": "boolean"
},
"IsExternalUser": {
"type": "boolean"
},
"Type": {
"type": [
"string"
]
},
"Notes": {
"type": [
"string"
]
},
"TeamsUserId": {
"type": [
"string"
]
},
"HelpTeamsUserId": {
"type": [
"string"
]
},
"TVATeamsUserId": {
"type": [
"string"
]
},
"TeamsTimeZoneName": {
"type": [
"string"
]
},
"UserLocale": {
"type": "string"
},
"DisplayName": {
"type": "string"
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
},
"FullName": {
"type": "string"
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/PlatformUser?$filter={{UserFilterCriteria}}"fetch("https://app.tikit.ai/api/PlatformUser?$filter={{UserFilterCriteria}}", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/PlatformUser?$filter={{UserFilterCriteria}}" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://platformapp-07.azurewebsites.net/api/$metadata#PlatformUser",
"value": [
{
"UserName": "john.doe@example.com",
"AadObjectId": "a1b2c3d4-e5f6-7890-gh12-ijkl34567890",
"Salutation": null,
"GivenName": "John",
"MiddleName": null,
"FamilyName": "Doe",
"Email": "john.doe@example.com",
"PhoneNumber": null,
"MobilePhone": null,
"ServiceUrl": "https://smba.trafficmanager.net/amer/abcd1234-5678-9def-ghij-1234567890kl/",
"JobTitle": null,
"Department": null,
"CompanyName": null,
"EmployeeId": null,
"StreetAddress": null,
"State": null,
"Country": null,
"Office": null,
"City": null,
"ZipCode": null,
"OfficePhone": "12345678901",
"BlockSignIn": false,
"IsExternalUser": false,
"Type": null,
"Notes": null,
"TeamsUserId": "29:abcdefgH1iJklMnOPqrS01234stuvWxyzABCD5678EFGH",
"HelpTeamsUserId": null,
"TVATeamsUserId": "29:ijklmnopQRstuvXYZ1234567890abcdEFGHijklMNOPQR",
"TeamsTimeZoneName": "Central Standard Time",
"UserLocale": "en-US",
"DisplayName": "John Doe",
"Id": 2,
"ModifiedDate": "2025-04-03T21:26:19.3991113Z",
"ModifiedById": 2,
"CreatedDate": "2024-03-12T12:36:18.7789659Z",
"CreatedById": null,
"Guid": "a1b2c3d4-e5f6-7890-gh12-ijkl34567890",
"IsDeleted": false,
"FullName": "John Doe"
}
]
}
GET
https://app.tikit.ai/api/PlatformUser
Get Users
This endpoint, with no filter criteria or any other parameters, will return an array of all users and properties.
Response Schema Hide
{
"type": "object",
"properties": {
"@odata.context": {
"type": "string",
"format": "uri"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"UserName": {
"type": "string",
"format": "email"
},
"AadObjectId": {
"type": "string",
"format": "uuid"
},
"Salutation": {
"type": [
"string"
]
},
"GivenName": {
"type": [
"string"
]
},
"MiddleName": {
"type": [
"string"
]
},
"FamilyName": {
"type": [
"string"
]
},
"Email": {
"type": [
"string"
],
"format": "email"
},
"PhoneNumber": {
"type": [
"string"
]
},
"MobilePhone": {
"type": [
"string"
]
},
"ServiceUrl": {
"type": "string",
"format": "uri"
},
"JobTitle": {
"type": [
"string"
]
},
"Department": {
"type": [
"string"
]
},
"CompanyName": {
"type": [
"string"
]
},
"EmployeeId": {
"type": [
"string"
]
},
"StreetAddress": {
"type": [
"string"
]
},
"State": {
"type": [
"string"
]
},
"Country": {
"type": [
"string"
]
},
"Office": {
"type": [
"string"
]
},
"City": {
"type": [
"string"
]
},
"ZipCode": {
"type": [
"string"
]
},
"OfficePhone": {
"type": [
"string"
]
},
"BlockSignIn": {
"type": "boolean"
},
"IsExternalUser": {
"type": "boolean"
},
"Type": {
"type": [
"string"
]
},
"Notes": {
"type": [
"string"
]
},
"TeamsUserId": {
"type": [
"string"
]
},
"HelpTeamsUserId": {
"type": [
"string"
]
},
"TVATeamsUserId": {
"type": [
"string"
]
},
"TeamsTimeZoneName": {
"type": [
"string"
]
},
"UserLocale": {
"type": "string"
},
"DisplayName": {
"type": "string"
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": [
"integer"
]
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": [
"integer"
]
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
},
"FullName": {
"type": "string"
}
}
}
}
}
}
Code Samples
curl -X GET -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/PlatformUser"
fetch("https://app.tikit.ai/api/PlatformUser", { method: "GET", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/PlatformUser" -Method GET -Headers @{Authorization = "Bearer <token>"}Try it out
PendingHide
Example Hide
{
"@odata.context": "https://platformapp-07.azurewebsites.net/api/$metadata#PlatformUser",
"value": [
{
"UserName": "john.doe@example.com",
"AadObjectId": "a1b2c3d4-e5f6-7890-gh12-ijkl34567890",
"Salutation": null,
"GivenName": "John",
"MiddleName": null,
"FamilyName": "Doe",
"Email": "john.doe@example.com",
"PhoneNumber": null,
"MobilePhone": null,
"ServiceUrl": "https://smba.trafficmanager.net/amer/abcd1234-5678-9def-ghij-1234567890kl/",
"JobTitle": null,
"Department": null,
"CompanyName": null,
"EmployeeId": null,
"StreetAddress": null,
"State": null,
"Country": null,
"Office": null,
"City": null,
"ZipCode": null,
"OfficePhone": "12345678901",
"BlockSignIn": false,
"IsExternalUser": false,
"Type": null,
"Notes": null,
"TeamsUserId": "29:abcdefgH1iJklMnOPqrS01234stuvWxyzABCD5678EFGH",
"HelpTeamsUserId": null,
"TVATeamsUserId": "29:ijklmnopQRstuvXYZ1234567890abcdEFGHijklMNOPQR",
"TeamsTimeZoneName": "Central Standard Time",
"UserLocale": "en-US",
"DisplayName": "John Doe",
"Id": 2,
"ModifiedDate": "2025-04-03T21:26:19.3991113Z",
"ModifiedById": 2,
"CreatedDate": "2024-03-12T12:36:18.7789659Z",
"CreatedById": null,
"Guid": "a1b2c3d4-e5f6-7890-gh12-ijkl34567890",
"IsDeleted": false,
"FullName": "John Doe"
}
]
}
POST
https://app.tikit.ai/api/PlatformUser
Create User
This endpoint is used for creating a new user. All that is required for creating the user is a
-
UserName. The properties should be passed as the JSON body payload. Once the user interacts with the Tikit or Tikit Virtual Agent Teams Apps, the rest of the details for the user will be populated.
Parameters
-
UserName(string, required) - The user's username in email format
Response Schema Hide
{
"type": "object",
"properties": {
"@odata.context": {
"type": "string",
"format": "uri"
},
"UserName": {
"type": "string",
"format": "email"
},
"AadObjectId": {
"type": [
"string"
]
},
"Salutation": {
"type": [
"string"
]
},
"GivenName": {
"type": "string"
},
"MiddleName": {
"type": "string"
},
"FamilyName": {
"type": "string"
},
"Email": {
"type": [
"string"
],
"format": "email"
},
"PhoneNumber": {
"type": [
"string"
]
},
"MobilePhone": {
"type": [
"string"
]
},
"ServiceUrl": {
"type": [
"string"
],
"format": "uri"
},
"JobTitle": {
"type": [
"string"
]
},
"Department": {
"type": [
"string"
]
},
"CompanyName": {
"type": [
"string"
]
},
"EmployeeId": {
"type": [
"string"
]
},
"StreetAddress": {
"type": [
"string"
]
},
"State": {
"type": [
"string"
]
},
"Country": {
"type": [
"string"
]
},
"Office": {
"type": [
"string"
]
},
"City": {
"type": [
"string"
]
},
"ZipCode": {
"type": [
"string"
]
},
"OfficePhone": {
"type": [
"string"
]
},
"BlockSignIn": {
"type": "boolean"
},
"IsExternalUser": {
"type": "boolean"
},
"Type": {
"type": [
"string"
]
},
"Notes": {
"type": [
"string"
]
},
"TeamsUserId": {
"type": [
"string"
]
},
"HelpTeamsUserId": {
"type": [
"string"
]
},
"TVATeamsUserId": {
"type": [
"string"
]
},
"TeamsTimeZoneName": {
"type": "string"
},
"UserLocale": {
"type": "string"
},
"DisplayName": {
"type": [
"string"
]
},
"Id": {
"type": "integer"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedById": {
"type": "integer"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"CreatedById": {
"type": "integer"
},
"Guid": {
"type": "string",
"format": "uuid"
},
"IsDeleted": {
"type": "boolean"
},
"FullName": {
"type": "string"
}
}
}
Code Samples
curl -X POST -H "Authorization: Bearer <token>" "https://app.tikit.ai/api/PlatformUser"
fetch("https://app.tikit.ai/api/PlatformUser", { method: "POST", headers: {"Authorization": "Bearer <token>"} })$response = Invoke-RestMethod -Uri "https://app.tikit.ai/api/PlatformUser" -Method POST -Headers @{Authorization = "Bearer <token>"}Request Example
{
"UserName": "sam.brown@example.com"
}
Try it out
PendingHide
Example Hide
{
"@odata.context": "https://tikit-api-01.azurewebsites.net/api/$metadata#PlatformUser/$entity",
"UserName": "sam.brown@example.com",
"AadObjectId": null,
"Salutation": null,
"GivenName": "",
"MiddleName": "",
"FamilyName": "",
"Email": null,
"PhoneNumber": null,
"MobilePhone": null,
"ServiceUrl": null,
"JobTitle": null,
"Department": null,
"CompanyName": null,
"EmployeeId": null,
"StreetAddress": null,
"State": null,
"Country": null,
"Office": null,
"City": null,
"ZipCode": null,
"OfficePhone": null,
"BlockSignIn": false,
"IsExternalUser": true,
"Type": null,
"Notes": null,
"TeamsUserId": null,
"HelpTeamsUserId": null,
"TVATeamsUserId": null,
"TeamsTimeZoneName": "UTC",
"UserLocale": "en-US",
"DisplayName": null,
"Id": 92,
"ModifiedDate": "2025-04-15T19:47:08.9459809Z",
"ModifiedById": 10,
"CreatedDate": "2025-04-15T19:47:08.6434322Z",
"CreatedById": 10,
"Guid": "e36de8df-b7f9-472d-a53a-4534236581b6",
"IsDeleted": false,
"FullName": "sam.brown@example.com"
}