Appearance

Overview ​

Comments allow team members to discuss and collaborate on work items by adding 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

    HTML string version of the comment

  • comment_stripped string

    Stripped string version of the comment

  • comment_json object

    JSON object version of the comment

  • attachments string[]

    Array of attachment URLs

  • access string

    If the comment should be visible externally also if the project is published or not. Takes in two values

    • INTERNAL
    • EXTERNAL

  • external_source string

    External source identifier

  • external_id string

    External ID from the external source

  • is_member boolean

    Whether the current user is a member of the project

  • created_by , updated_by uuid

    These values are auto saved and represent the id of the user that created or updated the comment

  • project uuid

    It contains project uuid which is automatically saved.

  • workspace uuid

    It contains workspace uuid which is automatically saved

  • issue uuid

    The work item the comment is attached to

  • actor uuid

    UUID of the user who commented.

Response200
json
{
  "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"
}