Comments
Add, edit, and manage comments on tickets.
Comments allow team members to discuss and collaborate on tickets. Spedy supports threaded replies and secret comments that are only visible to team members (not customers).
List Comments
GET /api/v1/boards/{boardId}/tickets/{ticketId}/commentsQuery Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| page | number | No | Page number (default: 1) |
| limit | number | No | Items per page (default: 20) |
Example Response
{
"data": [
{
"id": "cmt_abc123",
"content": "I've reproduced this on Chrome 120.",
"isSecret": false,
"author": {
"id": "usr_abc123",
"name": "Alex Smith"
},
"parentId": null,
"createdAt": "2025-03-15T14:30:00Z",
"updatedAt": "2025-03-15T14:30:00Z"
}
]
}Create Comment
POST /api/v1/boards/{boardId}/tickets/{ticketId}/commentsRequest Body
| Field | Type | Required | Description |
|---|---|---|---|
| content | string | Yes | Comment content (max 10,000 characters) |
| isSecret | boolean | No | Secret comment visible only to team members (requires tickets:add-secret-comments permission) |
| parentId | string | No | Parent comment ID for threaded replies |
Example Request
{
"content": "I've reproduced this on Chrome 120.",
"isSecret": false
}Get Comment
GET /api/v1/boards/{boardId}/tickets/{ticketId}/comments/{commentId}Returns a single comment.
Update Comment
PATCH /api/v1/boards/{boardId}/tickets/{ticketId}/comments/{commentId}Only the comment author or users with tickets:edit permission can update comments.
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| content | string | Yes | Updated comment content |
Delete Comment
DELETE /api/v1/boards/{boardId}/tickets/{ticketId}/comments/{commentId}Only the comment author or users with tickets:edit permission can delete comments. Returns 204 No Content.