Overview

Comments let team members discuss work items with text, mentions, and attachments.

Learn more about work item comments

The comments object

Attributes

• id uuid

  Unique identifier for the comment

• created_at timestamp

  The timestamp when the comment was created

• updated_at timestamp

  The timestamp when the comment was last updated

• deleted_at timestamp or null

  The timestamp when the comment was deleted (if deleted)

• edited_at timestamp or null

  The timestamp when the comment was last edited

• comment_html string

  The comment as an HTML string

• comment_stripped string

  The comment as plain text, with HTML removed

• comment_json object

  The comment as a JSON object

• attachments string[]

  Array of attachment URLs

• access string

  Whether the comment is visible externally when the project is published. Takes one of two values:

  • INTERNAL
  • EXTERNAL

• external_source string

  The system external_id came from, for example github or jira.

• external_id string

  Your system's identifier for this record, for sync and import correlation.

• is_member boolean

  Whether the current user is a member of the project

• created_by , updated_by uuid

  IDs of the users who created and last updated the comment. Set automatically.

• project uuid

  ID of the project. Set automatically.

• workspace uuid

  ID of the workspace. Set automatically.

• issue uuid

  The work item the comment is attached to

• actor uuid

  UUID of the user who commented.

Response200

{
  "id": "f3e29f26-708d-40f0-9209-7e0de44abc49",
  "created_at": "2023-11-20T09:26:10.383129Z",
  "updated_at": "2023-11-20T09:26:10.383140Z",
  "comment_stripped": "Initialf ThoughtsaMy initial thoughts on this are very  good",
  "comment_json": {},
  "comment_html": "<h1>Initialf Thoughts</h1>a<p>My initial thoughts on this are very  good</p>",
  "attachments": [],
  "access": "INTERNAL",
  "created_by": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "updated_by": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "project": "4af68566-94a4-4eb3-94aa-50dc9427067b",
  "workspace": "cd4ab5a2-1a5f-4516-a6c6-8da1a9fa5be4",
  "issue": "e1c25c66-5bb8-465e-a818-92a483423443",
  "actor": "16c61a3a-512a-48ac-b0be-b6b46fe6f430"
}