Comments API

Add and manage comments on issues for discussion, specs, and status updates.

List Comments

GET /api/v1/comments?issueId={issueId}

Returns all comments for an issue, ordered by creation date.

Query Parameters

Parameter	Type	Description
`issueId`	string	Required. The issue to list comments for.

Example Response

{
  "items": [
    {
      "id": "comment-id",
      "issueId": "issue-id",
      "body": "This looks good. Ready for review.",
      "authorId": "user-id",
      "authorName": "alex",
      "createdAt": "2025-03-20T10:30:00Z"
    }
  ]
}

Create Comment

POST /api/v1/comments

Request Body

{
  "issueId": "issue-id",
  "body": "Starting work on this. ETA: end of day."
}

Field	Required	Description
`issueId`	Yes	The issue to comment on
`body`	Yes	Comment text

Delete Comment

DELETE /api/v1/comments/{id}

Permanently deletes a comment.

Scopes Required

Action	Scope
List comments	`comments:read`
Create comment	`comments:write`
Delete comment	`comments:write`