Skip to main content

​
MCP tool: get_comments_by_user_type

Retrieves comments filtered by user type (internal/external) for a specific entity. Useful for separating internal team comments from customer-facing comments.

​
Example prompt

Get internal comments for ticket 71XNF90K10YBR86G1AN06KZJJFX40

​
Input parameters

NameTypeRequiredDescription
userTypestringYesThe type of user to filter comments by
entityTypestringYesThe type of entity to filter comments by (e.g., ticket, account)
entityIdstringYesThe ID of the entity to filter comments by

​
User types

Common user types include:
  • internal - Team members and internal users
  • external - Customers and external users
  • agent - Support agents
  • customer - End customers

​
Response fields

Below are the fields you may see in the response:
FieldTypeDescription
idstringComment unique ID
contentstringPlain text content of the comment
contentHtmlstringHTML formatted content
contentMarkdownstringMarkdown formatted content
contentJsonstringJSON formatted content for rich text
isEditedbooleanWhether the comment has been edited
threadNamestringName of the comment thread
commentVisibilitystringVisibility setting (public or private)
commentTypestringType of comment (note, reply, comment, etc.)
isPinnedbooleanWhether the comment is pinned
sourceEmailIdstringEmail ID if comment came from email
metadataobjectAdditional metadata including mentions
createdAtstring (ISO8601)Creation timestamp
updatedAtstring (ISO8601)Last update timestamp
authorstringAuthor display name
authorAvatarUrlstringAuthor’s avatar URL
authorIdstringAuthor’s user ID
authorUserTypestringAuthor’s user type (e.g., ORG_ADMIN)
impersonatedUserEmailstringEmail of impersonated user
impersonatedUserNamestringName of impersonated user
impersonatedUserAvatarstringAvatar of impersonated user
deletedAtstringDeletion timestamp (null if not deleted)

​
Sample response

{
  "data": {
    "id": "X66KS01K10E5FVTJK7ZVRW3AKVYDD",
    "content": "this is a reply",
    "contentHtml": "<p>this is a reply</p>",
    "contentMarkdown": "this is a reply",
    "contentJson": "\"{\\"type\\":\\"doc\\",\\"content\\":[{\\"type\\":\\"paragraph\\",\\"attrs\\":{\\"textAlign\\":\\"left\\"},\\"content\\":[{\\"type\\":\\"text\\",\\"text\\":\\"this is a reply\\"}]}]}\"",
    "isEdited": false,
    "threadName": null,
    "commentVisibility": "public",
    "commentType": "comment",
    "isPinned": false,
    "sourceEmailId": null,
    "metadata": {
      "mentions": []
    },
    "createdAt": "2025-07-25T12:40:41.944Z",
    "updatedAt": "2025-07-25T12:40:41.941Z",
    "author": "shakthi+1",
    "authorAvatarUrl": null,
    "authorId": "UTH00SEXXFNVVN",
    "authorUserType": "ORG_ADMIN",
    "impersonatedUserEmail": null,
    "impersonatedUserName": null,
    "impersonatedUserAvatar": null,
    "deletedAt": null
  },
  "status": true,
  "message": "Comments fetched successfully!",
  "timestamp": "2025-07-25T12:50:38.937Z"
}