Skip to main content

comments

Overview

Namecomments
TypeResource
Idgithub.issues.comments

Fields

NameDatatypeDescription
idintegerUnique identifier of the issue comment
author_associationstringHow the author is associated with the repository.
bodystringContents of the issue comment
body_htmlstring
body_textstring
created_atstring
html_urlstring
issue_urlstring
node_idstring
performed_via_github_appobjectGitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
reactionsobject
updated_atstring
urlstringURL for the issue comment
userobjectA GitHub user.

Methods

NameAccessible byRequired ParamsDescription
get_commentSELECTcomment_id, owner, repoYou can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
list_commentsSELECTissue_number, owner, repoYou can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

Issue comments are ordered by ascending ID.
list_comments_for_repoSELECTowner, repoYou can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.

By default, issue comments are ordered by ascending ID.
create_commentINSERTissue_number, owner, repo, data__body
You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

This endpoint triggers notifications.
Creating content too quickly using this endpoint may result in secondary rate limiting.
See "Secondary rate limits"
and "Dealing with secondary rate limits"
for details.
delete_commentDELETEcomment_id, owner, repoYou can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
update_commentEXECcomment_id, owner, repo, data__bodyYou can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.