The chat ID is provided in the route. Supports filtering, sorting, and pagination via query string parameters.
The chat ID.
OK
Flag indicates whether participant should be notified of new messages in the chat.
Content of the chat message.
Set to true when the message should be considered deleted
Flag indicates whether participant should be notified of new messages in the chat.
Content of the chat message.
Set to true when the message should be considered deleted
Content of the chat message.
Set to true when the message should be considered deleted
Represents the URI for link.
Represents the ObjectId for link.
Content of the chat message.
Set to true when the message should be considered deleted
Represents the URI for link.
Represents the ObjectId for link.
GET /public/v1/helpdesk/chats/{chatId}/links HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
OK
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"message": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"madePublic": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"madePrivate": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"chat": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Direct"
},
"sender": {
"id": "text",
"revision": 1,
"muted": true,
"status": "Active"
},
"content": "text",
"visibility": "Public",
"isDeleted": true,
"links": [
"[Circular Reference]"
],
"identity": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
},
"replyTo": {
"id": "text",
"revision": 1,
"content": "text",
"visibility": "Public",
"isDeleted": true
}
},
"chat": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Direct"
},
"uri": "text",
"objectId": "text"
}
]
}