Sign in

v1

latestOpenAPI 3.1.02026-07-24172151607.6 KB
Comments

Get Task Comments

View task comments.

Retrieve comments from a task. Results are returned in reverse chronological order (newest to oldest). By default, the request returns the 25 most recent comments.

Pagination: To fetch the next page of history (older comments), you must use the start and start_id parameters together, using the data from the last comment of the current response.

get/v2/task/{task_id}/comment

Path parameters

task_idstring required
Example:9hz

Query parameters

custom_task_idsboolean
Example:true

If you want to reference a task by it's custom task id, this value must be true.

team_idnumber
Example:123

When the custom_task_ids parameter is set to true, the Workspace ID must be provided using the team_id parameter.
For example: custom_task_ids=true&team_id=123.

startinteger

The Unix timestamp (in milliseconds) of the reference comment. Required for pagination. Must be used in combination with start_id.
Value should be the date of the last comment from the previous response.

start_idstring

The unique ID of the reference comment. Required for pagination. Must be used in combination with start.
Value should be the id of the last comment from the previous response.

Response

Example response

{
  "comments": [
    {
      "id": "458",
      "comment": [
        {
          "text": "Task comment content"
        }
      ],
      "comment_text": "Task comment content",
      "user": {
        "id": 183,
        "username": "John Doe",
        "initials": "JD",
        "email": "johndoe@gmail.com",
        "color": "#827718",
        "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
      },
      "resolved": false,
      "assignee": {
        "id": 183,
        "username": "John Doe",
        "initials": "JD",
        "email": "johndoe@gmail.com",
        "color": "#827718",
        "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
      },
      "assigned_by": {
        "id": 183,
        "username": "John Doe",
        "initials": "JD",
        "email": "johndoe@gmail.com",
        "color": "#827718",
        "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
      },
      "reactions": [],
      "date": "1568036964079",
      "reply_count": "1"
    }
  ]
}