Skip to main content

Get Task Comments (v1)

Method + Path

GET /v1/workspace/staff/:staffId/tasks/:taskId/comments

Actual backend path: /v1/workspace/staff/:staffId/tasks/:taskId/comments

Description

Get all comments for a specific task.

Authentication

Required - JWT token in Authorization header

Required Permissions:

  • staff.view or task-related permissions

Headers

HeaderTypeRequiredDescription
AuthorizationstringYesBearer token: Bearer <token>

Path Parameters

ParameterTypeRequiredDescription
staffIdstringYesStaff member identifier
taskIdstringYesTask identifier

Response (200)

{
"comments": [
{
"id": "507f1f77bcf86cd799439013",
"authorId": "507f1f77bcf86cd799439012",
"authorType": "staff",
"authorName": "John Doe",
"authorAvatarUrl": "https://example.com/avatar.jpg",
"body": "This task is progressing well.",
"createdAt": "2024-01-15T11:00:00Z"
}
]
}

Common Errors

  • 401 Unauthorized: Missing or invalid authentication token
  • 403 Forbidden: Insufficient permissions
  • 404 Not Found: Task or staff member not found
  • 500 Internal Server Error: Server error