CLclickup
Comments

Get List Comments

Changed on

View the comments added to a List.

If you do not include the start and start_id parameters, this endpoint will return the most recent 25 comments.

Use the start and start id parameters of the oldest comment to retrieve the next 25 comments.

get/v2/list/{list_id}/comment

Request

  • Base URL
    https://api.clickup.com/api
  • URL
    https://api.clickup.com/api/v2/list/{list_id}/comment
  • Auth
    API key in header Authorization

Path parameters

list_idnumber required
Example:124

Query parameters

startinteger

Enter the date of a List info comment using Unix time in milliseconds.

start_idstring

Enter the Comment id of a List info comment.

Response

commentsItems[] required(unresolved $ref)

Example response

{
  "comments": [
    {
      "id": "462",
      "comment": [
        {
          "text": "List comment content"
        }
      ],
      "comment_text": "List 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"
    }
  ]
}

Changes

  • a0a72ec97ddbRevision changes
    • breaking

      the / response's property type changed from no type to object for status

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status