Skip to content

All resources

comments

9 endpoints

get /bugs/{id}/comments

[Deprecated] List a task's comments via the legacy bug/feature path

Requires authentication

Deprecated alias of GET /tasks/{id}/comments. Use /api/v1/tasks/{id}/comments.

Parameters

NameInTypeRequiredDescription
idpathintegeryesTask id

Responses

  • 200 OK · object
  • 404 Not Found · apimodel.ErrorEnvelope

post /bugs/{id}/comments

[Deprecated] Add a comment via the legacy bug/feature path

Requires authentication

Deprecated alias of POST /tasks/{id}/comments. Use /api/v1/tasks/{id}/comments.

Parameters

NameInTypeRequiredDescription
idpathintegeryesTask id

Request body: apimodel.CreateCommentRequest

NameTypeRequiredDescription
contentstringno

Responses

  • 201 Created · object
  • 404 Not Found · apimodel.ErrorEnvelope

patch /comments/{id}

Edit a comment

Requires authentication

Updates a comment's content, snapshots the prior body to edit history, and fans out newly-added @mention notifications.

Parameters

NameInTypeRequiredDescription
idpathintegeryesComment id

Request body: apimodel.CreateCommentRequest

NameTypeRequiredDescription
contentstringno

Responses

  • 200 OK · object
  • 400 Bad Request · apimodel.ErrorEnvelope
  • 401 Unauthorized · apimodel.ErrorEnvelope
  • 403 Forbidden · apimodel.ErrorEnvelope
  • 404 Not Found · apimodel.ErrorEnvelope

delete /comments/{id}

Delete a comment

Requires authentication

Permanently deletes a comment. Author-only (org owners/admins may remove any comment).

Parameters

NameInTypeRequiredDescription
idpathintegeryesComment id

Responses

  • 200 OK · object
  • 401 Unauthorized · apimodel.ErrorEnvelope
  • 403 Forbidden · apimodel.ErrorEnvelope
  • 404 Not Found · apimodel.ErrorEnvelope

get /comments/{id}/edits

List a comment's edit history

Requires authentication

Returns the edit-history snapshots for a comment, oldest first. Visible to org members of the comment's parent task.

Parameters

NameInTypeRequiredDescription
idpathintegeryesComment id

Responses

  • 200 OK · object
  • 401 Unauthorized · apimodel.ErrorEnvelope
  • 404 Not Found · apimodel.ErrorEnvelope

get /features/{id}/comments

[Deprecated] List a task's comments via the legacy bug/feature path

Requires authentication

Deprecated alias of GET /tasks/{id}/comments. Use /api/v1/tasks/{id}/comments.

Parameters

NameInTypeRequiredDescription
idpathintegeryesTask id

Responses

  • 200 OK · object
  • 404 Not Found · apimodel.ErrorEnvelope

post /features/{id}/comments

[Deprecated] Add a comment via the legacy bug/feature path

Requires authentication

Deprecated alias of POST /tasks/{id}/comments. Use /api/v1/tasks/{id}/comments.

Parameters

NameInTypeRequiredDescription
idpathintegeryesTask id

Request body: apimodel.CreateCommentRequest

NameTypeRequiredDescription
contentstringno

Responses

  • 201 Created · object
  • 404 Not Found · apimodel.ErrorEnvelope

get /tasks/{id}/comments

List a task's comments

Requires authentication

Returns a keyset page of a task's comment thread (oldest first), each joined with its author. Follow meta.nextCursor for the rest of the thread.

Parameters

NameInTypeRequiredDescription
idpathintegeryesTask id
limitqueryintegernoPage size (default 50, max 200)
cursorquerystringnoOpaque keyset cursor from a previous page's meta.nextCursor

Responses

  • 200 OK · object
  • 400 Bad Request · apimodel.ErrorEnvelope
  • 401 Unauthorized · apimodel.ErrorEnvelope
  • 404 Not Found · apimodel.ErrorEnvelope

post /tasks/{id}/comments

Add a comment to a task

Requires authentication

Posts a comment to a task's thread and fans out @mention + subscriber notifications.

Parameters

NameInTypeRequiredDescription
idpathintegeryesTask id
Idempotency-KeyheaderstringnoOptional key making the comment create safe to retry

Request body: apimodel.CreateCommentRequest

NameTypeRequiredDescription
contentstringno

Responses

  • 201 Created · object
  • 400 Bad Request · apimodel.ErrorEnvelope
  • 401 Unauthorized · apimodel.ErrorEnvelope
  • 404 Not Found · apimodel.ErrorEnvelope