Get comment by ID
/v1/comments/{id}org.permission.note.readorg.user.note.readThe API key or user must hold at least one of them. Legacy roles still work; prefer the others for new keys.
Retrieves a comment based on the unique comment ID.
You can also retrieve multiple comments by providing a comma-separated list of IDs.
Comments
A comment is a short internal note that agents leave on a custom object record, such as a task. Customers never see comments; they are for discussion among your team, with optional mentions and attachments.
Comments let agents discuss a KObject, for example to record progress on a task or ask a teammate about a return. They appear on the record in the agent desktop for Klasses that have the commentable mixin. Comments are separate from notes: notes attach to customers and conversations, while comments attach only to KObjects.
A comment is created against one KObject and stays attached to it. Its body can be edited later, and it is removed with DELETE. Only the comment's author can edit or delete it, unless the caller has admin access to notes. Responses also include relationships to the related customer, conversation and Klass, and to the assigned user and team where there are any.
Key fields
| Field | Meaning |
|---|---|
body |
Required. The comment text, up to 10,240 characters. |
userMentions |
Up to 20 mentions, each with a user or a team ID. |
attachments |
Files attached to the comment. Read them back with include=attachments, or manage them with the comment attachments endpoints. |
importedAt |
Marks a comment you are importing from another system. |
object |
In responses, the KObject the comment belongs to. |
createdAt, modifiedAt, deletedAt and the createdBy, modifiedBy and deletedBy relationships record who did what and when.
Which endpoint to use
| To | Call |
|---|---|
| List the comments on a KObject | GET /v1/kobjects/{id}/comments |
| Add a comment to a KObject | POST /v1/kobjects/{id}/comments |
| Read one or several comments | GET /v1/comments/{id} |
| Edit or delete a comment | PUT or DELETE /v1/comments/{id} |
The list endpoint takes the KObject's ID (no Klass name needed), pages with page and pageSize, and sorts by createdAt with sort=asc or sort=desc. GET /v1/comments/{id} accepts a comma-separated list of IDs to fetch several comments at once. Permissions differ by endpoint: listing comments needs KObject read access, while reading, creating, updating and deleting individual comments use note roles (such as org.permission.note.create), so give your API key both.
Path parameters
Unique comment ID. Supports a comma-separated list of IDs for multi-get.
"57cf1d65079e780006e34f79"Query parameters
Comma-separated related resources to include. Supports attachments.
"attachments"Responses
OK