Get Comments

GET/api/v1/comments

Retrieve a paginated list of comments in a chat room.

Request

Authorization

Bearer Token

Provide your API token in the Authorization header. See Authentication to issue one.

Example:Authorization: Bearer ********************

Query Params

pageintegeroptional
Default:1
Example:1
pageSizeintegeroptional
Default:20
Example:20
contactIdstring<uuid>required

Responses

200

requestIdstringrequired
dataarray[object]required
Child attributes
- idstringrequired
- roomIdstringrequired
- textstringrequired
- typestringrequired
- mentionsarray[object]required
  Child attributes
  userIdstringoptional
  namestringoptional
- senderobjectrequired
  Child attributes
  idstringrequired
  namestringrequired
- createdAtstringrequired
pageintegerrequired
pageSizeintegerrequired
totalintegerrequired
lastPageintegerrequired

Request

curl -X GET "https://apigw.klinkcx.com/api/v1/comments?contactId=%7BcontactId%7D" \
  -H "Authorization: Bearer {token}"

Response

{
  "requestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "data": [
    {
      "id": "comment-uuid-002",
      "roomId": "room-uuid-abc",
      "text": "The issue has been resolved.",
      "type": "comment",
      "mentions": [],
      "sender": {
        "id": "user-uuid-456",
        "name": "Agent Name"
      },
      "createdAt": "2026-02-27T11:05:00Z"
    },
    {
      "id": "comment-uuid-001",
      "roomId": "room-uuid-abc",
      "text": "@John Doe Please review this case.",
      "type": "comment",
      "mentions": [
        {
          "userId": "user-uuid-123",
          "name": "John Doe"
        }
      ],
      "sender": {
        "id": "user-uuid-789",
        "name": "Admin User"
      },
      "createdAt": "2026-02-27T11:00:00Z"
    }
  ],
  "page": 1,
  "pageSize": 20,
  "total": 2,
  "lastPage": 1
}