Sign in

v2

latestOpenAPI 3.0.12026-07-31690160432.4 KB
Task Comments

Get comments for a task

Retrieve all comments (including parent comments and replies) for a given task.

Usage Notes:

  • Parent comments have parentCommentId = null.
  • Replies have parentCommentId set to the ID of the parent comment.
  • Clients can use this field to group replies under their parent comment for a threaded conversation view.
  • The sort parameter controls the order of parent comments (replies should be grouped by client regardless of sort order).
  • The comment field may contain HTML with @mention markup. Use mentionedUserIds to identify mentioned users.
get/v1/tasks/{taskId}/comments

Path parameters

taskIdinteger required

ID of the task

Query parameters

sortstring

Sort order (asc or desc)

Headers

X-Org-Idinteger required

Organization ID

Response

Comments fetched successfully

successboolean

Indicates if the operation was successful

messagestring

Message describing the result of the operation

codeinteger

HTTP status code of the response

timestampstring date-time

Timestamp of the response

Example response

{
  "success": true,
  "message": "Operation completed successfully",
  "code": 200,
  "timestamp": "2023-01-01T12:00:00Z"
}