Ticket link
A ticket link connects two tickets and says how they relate. Links are directional and are always read from the perspective of the ticket in the path: linking A to B as BLOCKS means B shows the link as BLOCKED_BY.
Link
Counterpart
SUBTASK_OF
PARENT_OF
BLOCKED_BY
BLOCKS
DUPLICATE_OF
DUPLICATED_BY
CAUSED_BY
CAUSES
RELATES_TO
RELATES_TO
Returns the tickets linked to this one, each with the link type as seen from this ticket.
Filterable — id, sourceTicketId, targetTicketId, relationType, creatorId, createdAt.
Sortable — id, createdAt.
Searchable — nothing yet.
Authorizations
AuthorizationstringRequired
Token issued by the central equipme authentication, sent as Bearer <token>.
Path parameters
ticketIdintegerRequiredExample:
Ticket id
4211Query parameters
filterstringOptional
JSON filter expression
searchstringOptional
Free-text term — no effect here
sortstringOptional
Comma-separated field:direction terms
fieldsstringOptionalExample:
Selection of fields and relations
type,relatedTicket.subjectoffsetintegerOptionalDefault:
Number of entries to skip
0limitintegerOptionalDefault:
Page size, 1 to 100
100Responses
200
OK
application/json
countintegerOptional
400
Bad Request
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
500
Internal Server Error
application/json
get/v1/tickets/{ticketId}/links
GET /api/v1/tickets/{ticketId}/links HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"count": 1,
"data": [
{
"createdAt": "text",
"creator": {
"assignmentContext": "text",
"autoAssign": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"description": "text",
"email": "ada.lovelace@example.com",
"firstName": "Ada",
"id": 17,
"kind": "",
"lastName": "Lovelace",
"mobile": "text",
"phone": "text",
"tenant": {
"id": 1,
"name": "text"
},
"tenantId": 1,
"title": "text",
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"relatedTicket": {
"agent": {
"assignmentContext": "text",
"autoAssign": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"description": "text",
"email": "ada.lovelace@example.com",
"firstName": "Ada",
"id": 17,
"kind": "",
"lastName": "Lovelace",
"mobile": "text",
"phone": "text",
"tenant": {
"id": 1,
"name": "text"
},
"tenantId": 1,
"title": "text",
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"agentId": 23,
"assignee": {
"assignmentContext": "text",
"autoAssign": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"description": "text",
"email": "ada.lovelace@example.com",
"firstName": "Ada",
"id": 17,
"kind": "",
"lastName": "Lovelace",
"mobile": "text",
"phone": "text",
"tenant": {
"id": 1,
"name": "text"
},
"tenantId": 1,
"title": "text",
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"assigneeId": 17,
"contact": {
"assignmentContext": "text",
"autoAssign": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"description": "text",
"email": "ada.lovelace@example.com",
"firstName": "Ada",
"id": 17,
"kind": "",
"lastName": "Lovelace",
"mobile": "text",
"phone": "text",
"tenant": {
"id": 1,
"name": "text"
},
"tenantId": 1,
"title": "text",
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"contactId": 91,
"createdAt": "2026-03-14T09:12:00Z",
"id": 4211,
"impact": {
"color": "#f5a623",
"createdAt": "2026-01-01T00:00:00.000Z",
"displayName": "Abteilung",
"level": 2,
"name": "department",
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"impactName": "text",
"labels": [
{
"assignmentContext": "text",
"autoAssign": true,
"color": "#4a90d9",
"createdAt": "2026-01-01T00:00:00.000Z",
"description": "text",
"id": 12,
"name": "hardware",
"tenant": {
"id": 1,
"name": "text"
},
"tenantId": 1,
"updatedAt": "2026-01-01T00:00:00.000Z"
}
],
"opener": {
"assignmentContext": "text",
"autoAssign": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"description": "text",
"email": "ada.lovelace@example.com",
"firstName": "Ada",
"id": 17,
"kind": "",
"lastName": "Lovelace",
"mobile": "text",
"phone": "text",
"tenant": {
"id": 1,
"name": "text"
},
"tenantId": 1,
"title": "text",
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"openerId": 91,
"priority": {
"color": "#d0021b",
"createdAt": "2026-01-01T00:00:00.000Z",
"displayName": "Hoch",
"level": 3,
"name": "high",
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"priorityName": "text",
"status": {
"allowedSourceStatuses": [
"[Circular Reference]"
],
"allowedTargetStatuses": [
"[Circular Reference]"
],
"color": "#f5a623",
"createdAt": "2026-01-01T00:00:00.000Z",
"displayName": "In progress",
"isDefault": true,
"name": "in_progress",
"position": 2,
"tenant": {
"id": 1,
"name": "text"
},
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"statusName": "text",
"subject": "Printer on the 2nd floor is not printing",
"summary": "The network printer on the 2nd floor has stopped accepting jobs since Monday; a restart did not help.",
"thread": {
"attachments": [
{
"composing": true,
"contentId": "text",
"contentType": "text",
"createdAt": "text",
"creator": {
"assignmentContext": "text",
"autoAssign": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"description": "text",
"email": "ada.lovelace@example.com",
"firstName": "Ada",
"id": 17,
"kind": "",
"lastName": "Lovelace",
"mobile": "text",
"phone": "text",
"tenant": {
"id": 1,
"name": "text"
},
"tenantId": 1,
"title": "text",
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"creatorId": 1,
"id": 1,
"inline": true,
"link": "text",
"messageId": 1,
"name": "text",
"size": 1,
"threadId": 1
}
],
"channel": {
"active": true,
"createdAt": "text",
"id": 1,
"kind": "",
"name": "text",
"purpose": "",
"tenant": {
"id": 1,
"name": "text"
},
"tenantId": 1,
"updatedAt": "text"
},
"channelId": 1,
"createdAt": "2026-01-01T00:00:00.000Z",
"description": "text",
"externalId": "text",
"id": 8801,
"messages": [
"[Circular Reference]"
],
"parent": {
"attachments": [
{
"composing": true,
"contentId": "text",
"contentType": "text",
"createdAt": "text",
"creator": {
"assignmentContext": "text",
"autoAssign": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"description": "text",
"email": "ada.lovelace@example.com",
"firstName": "Ada",
"id": 17,
"kind": "",
"lastName": "Lovelace",
"mobile": "text",
"phone": "text",
"tenant": {
"id": 1,
"name": "text"
},
"tenantId": 1,
"title": "text",
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"creatorId": 1,
"id": 1,
"inline": true,
"link": "text",
"messageId": 1,
"name": "text",
"size": 1,
"threadId": 1
}
],
"channel": {
"active": true,
"createdAt": "text",
"id": 1,
"kind": "",
"name": "text",
"purpose": "",
"tenant": {
"id": 1,
"name": "text"
},
"tenantId": 1,
"updatedAt": "text"
},
"channelId": 1,
"createdAt": "2026-01-01T00:00:00.000Z",
"description": "text",
"externalId": "text",
"id": 8801,
"messages": "[Circular Reference]",
"parent": "[Circular Reference]",
"parentId": 1,
"participants": [
{
"assignmentContext": "text",
"autoAssign": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"description": "text",
"email": "ada.lovelace@example.com",
"firstName": "Ada",
"id": 17,
"kind": "",
"lastName": "Lovelace",
"mobile": "text",
"phone": "text",
"tenant": {
"id": 1,
"name": "text"
},
"tenantId": 1,
"title": "text",
"updatedAt": "2026-01-01T00:00:00.000Z"
}
],
"status": "",
"subject": "Printer on the 2nd floor is not printing",
"tenant": {
"id": 1,
"name": "text"
},
"tenantId": 1,
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"parentId": 1,
"participants": [
{
"assignmentContext": "text",
"autoAssign": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"description": "text",
"email": "ada.lovelace@example.com",
"firstName": "Ada",
"id": 17,
"kind": "",
"lastName": "Lovelace",
"mobile": "text",
"phone": "text",
"tenant": {
"id": 1,
"name": "text"
},
"tenantId": 1,
"title": "text",
"updatedAt": "2026-01-01T00:00:00.000Z"
}
],
"status": "",
"subject": "Printer on the 2nd floor is not printing",
"tenant": {
"id": 1,
"name": "text"
},
"tenantId": 1,
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"threadId": 8801,
"type": {
"assignmentContext": "text",
"autoAssign": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"displayName": "Incident",
"name": "incident",
"position": 1,
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"typeName": "text",
"updatedAt": "2026-03-14T11:03:00Z",
"urgency": {
"color": "#d0021b",
"createdAt": "2026-01-01T00:00:00.000Z",
"displayName": "Hoch",
"level": 3,
"name": "high",
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"urgencyName": "text"
},
"type": ""
}
]
}Links this ticket to others. Each entry names the ticketId to link and the type as seen from the ticket in the path — the counterpart is recorded automatically for the other side.
A ticket cannot be linked to itself; that is answered with 400. Linking a pair that is already linked does not duplicate the link.
Authorizations
AuthorizationstringRequired
Token issued by the central equipme authentication, sent as Bearer <token>.
Path parameters
ticketIdintegerRequiredExample:
Ticket id
4211Body
objectOptional
Responses
201
Created
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
500
Internal Server Error
application/json
post/v1/tickets/{ticketId}/links
POST /api/v1/tickets/{ticketId}/links HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2
{}{
"data": [
{
"createdAt": "text",
"creator": {
"assignmentContext": "text",
"autoAssign": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"description": "text",
"email": "ada.lovelace@example.com",
"firstName": "Ada",
"id": 17,
"kind": "",
"lastName": "Lovelace",
"mobile": "text",
"phone": "text",
"tenant": {
"id": 1,
"name": "text"
},
"tenantId": 1,
"title": "text",
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"relatedTicket": {
"agent": {
"assignmentContext": "text",
"autoAssign": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"description": "text",
"email": "ada.lovelace@example.com",
"firstName": "Ada",
"id": 17,
"kind": "",
"lastName": "Lovelace",
"mobile": "text",
"phone": "text",
"tenant": {
"id": 1,
"name": "text"
},
"tenantId": 1,
"title": "text",
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"agentId": 23,
"assignee": {
"assignmentContext": "text",
"autoAssign": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"description": "text",
"email": "ada.lovelace@example.com",
"firstName": "Ada",
"id": 17,
"kind": "",
"lastName": "Lovelace",
"mobile": "text",
"phone": "text",
"tenant": {
"id": 1,
"name": "text"
},
"tenantId": 1,
"title": "text",
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"assigneeId": 17,
"contact": {
"assignmentContext": "text",
"autoAssign": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"description": "text",
"email": "ada.lovelace@example.com",
"firstName": "Ada",
"id": 17,
"kind": "",
"lastName": "Lovelace",
"mobile": "text",
"phone": "text",
"tenant": {
"id": 1,
"name": "text"
},
"tenantId": 1,
"title": "text",
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"contactId": 91,
"createdAt": "2026-03-14T09:12:00Z",
"id": 4211,
"impact": {
"color": "#f5a623",
"createdAt": "2026-01-01T00:00:00.000Z",
"displayName": "Abteilung",
"level": 2,
"name": "department",
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"impactName": "text",
"labels": [
{
"assignmentContext": "text",
"autoAssign": true,
"color": "#4a90d9",
"createdAt": "2026-01-01T00:00:00.000Z",
"description": "text",
"id": 12,
"name": "hardware",
"tenant": {
"id": 1,
"name": "text"
},
"tenantId": 1,
"updatedAt": "2026-01-01T00:00:00.000Z"
}
],
"opener": {
"assignmentContext": "text",
"autoAssign": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"description": "text",
"email": "ada.lovelace@example.com",
"firstName": "Ada",
"id": 17,
"kind": "",
"lastName": "Lovelace",
"mobile": "text",
"phone": "text",
"tenant": {
"id": 1,
"name": "text"
},
"tenantId": 1,
"title": "text",
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"openerId": 91,
"priority": {
"color": "#d0021b",
"createdAt": "2026-01-01T00:00:00.000Z",
"displayName": "Hoch",
"level": 3,
"name": "high",
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"priorityName": "text",
"status": {
"allowedSourceStatuses": [
"[Circular Reference]"
],
"allowedTargetStatuses": [
"[Circular Reference]"
],
"color": "#f5a623",
"createdAt": "2026-01-01T00:00:00.000Z",
"displayName": "In progress",
"isDefault": true,
"name": "in_progress",
"position": 2,
"tenant": {
"id": 1,
"name": "text"
},
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"statusName": "text",
"subject": "Printer on the 2nd floor is not printing",
"summary": "The network printer on the 2nd floor has stopped accepting jobs since Monday; a restart did not help.",
"thread": {
"attachments": [
{
"composing": true,
"contentId": "text",
"contentType": "text",
"createdAt": "text",
"creator": {
"assignmentContext": "text",
"autoAssign": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"description": "text",
"email": "ada.lovelace@example.com",
"firstName": "Ada",
"id": 17,
"kind": "",
"lastName": "Lovelace",
"mobile": "text",
"phone": "text",
"tenant": {
"id": 1,
"name": "text"
},
"tenantId": 1,
"title": "text",
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"creatorId": 1,
"id": 1,
"inline": true,
"link": "text",
"messageId": 1,
"name": "text",
"size": 1,
"threadId": 1
}
],
"channel": {
"active": true,
"createdAt": "text",
"id": 1,
"kind": "",
"name": "text",
"purpose": "",
"tenant": {
"id": 1,
"name": "text"
},
"tenantId": 1,
"updatedAt": "text"
},
"channelId": 1,
"createdAt": "2026-01-01T00:00:00.000Z",
"description": "text",
"externalId": "text",
"id": 8801,
"messages": [
"[Circular Reference]"
],
"parent": {
"attachments": [
{
"composing": true,
"contentId": "text",
"contentType": "text",
"createdAt": "text",
"creator": {
"assignmentContext": "text",
"autoAssign": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"description": "text",
"email": "ada.lovelace@example.com",
"firstName": "Ada",
"id": 17,
"kind": "",
"lastName": "Lovelace",
"mobile": "text",
"phone": "text",
"tenant": {
"id": 1,
"name": "text"
},
"tenantId": 1,
"title": "text",
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"creatorId": 1,
"id": 1,
"inline": true,
"link": "text",
"messageId": 1,
"name": "text",
"size": 1,
"threadId": 1
}
],
"channel": {
"active": true,
"createdAt": "text",
"id": 1,
"kind": "",
"name": "text",
"purpose": "",
"tenant": {
"id": 1,
"name": "text"
},
"tenantId": 1,
"updatedAt": "text"
},
"channelId": 1,
"createdAt": "2026-01-01T00:00:00.000Z",
"description": "text",
"externalId": "text",
"id": 8801,
"messages": "[Circular Reference]",
"parent": "[Circular Reference]",
"parentId": 1,
"participants": [
{
"assignmentContext": "text",
"autoAssign": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"description": "text",
"email": "ada.lovelace@example.com",
"firstName": "Ada",
"id": 17,
"kind": "",
"lastName": "Lovelace",
"mobile": "text",
"phone": "text",
"tenant": {
"id": 1,
"name": "text"
},
"tenantId": 1,
"title": "text",
"updatedAt": "2026-01-01T00:00:00.000Z"
}
],
"status": "",
"subject": "Printer on the 2nd floor is not printing",
"tenant": {
"id": 1,
"name": "text"
},
"tenantId": 1,
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"parentId": 1,
"participants": [
{
"assignmentContext": "text",
"autoAssign": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"description": "text",
"email": "ada.lovelace@example.com",
"firstName": "Ada",
"id": 17,
"kind": "",
"lastName": "Lovelace",
"mobile": "text",
"phone": "text",
"tenant": {
"id": 1,
"name": "text"
},
"tenantId": 1,
"title": "text",
"updatedAt": "2026-01-01T00:00:00.000Z"
}
],
"status": "",
"subject": "Printer on the 2nd floor is not printing",
"tenant": {
"id": 1,
"name": "text"
},
"tenantId": 1,
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"threadId": 8801,
"type": {
"assignmentContext": "text",
"autoAssign": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"displayName": "Incident",
"name": "incident",
"position": 1,
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"typeName": "text",
"updatedAt": "2026-03-14T11:03:00Z",
"urgency": {
"color": "#d0021b",
"createdAt": "2026-01-01T00:00:00.000Z",
"displayName": "Hoch",
"level": 3,
"name": "high",
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"urgencyName": "text"
},
"type": ""
}
]
}Removes the links between this ticket and the given ones, in whichever direction they were recorded. Ticket ids that are not linked are ignored. Answers with 204 and no body.
Authorizations
AuthorizationstringRequired
Token issued by the central equipme authentication, sent as Bearer <token>.
Path parameters
ticketIdintegerRequiredExample:
Ticket id
4211Body
objectOptional
Responses
204
No Content
No content
400
Bad Request
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
500
Internal Server Error
application/json
delete/v1/tickets/{ticketId}/links
DELETE /api/v1/tickets/{ticketId}/links HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2
{}No content
Last updated
Was this helpful?