Sample - GitHub REST API
GET/repos/{owner}/{repo}/pulls/{pull_number}/comments

List review comments on a pull request

Lists all review comments for a specified pull request. By default, review comments are in ascending order by ID.

This endpoint supports the following custom media types. For more information, see "Media types."

  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

8 parameters
ownerstringrequired
The account owner of the repository. The name is not case sensitive.
repostringrequired
The name of the repository without the `.git` extension. The name is not case sensitive.
pull_numberintegerrequired
The number that identifies the pull request.
sortstringoptional
The property to sort the results by.
Allowed:createdupdatedDefault:created
directionstringoptional
The direction to sort results. Ignored without `sort` parameter.
Allowed:ascdesc
sincestringoptional
Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
per_pageintegeroptional
The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
Default:30
pageintegeroptional
The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
Default:1

1 status code
200Response
urlstringrequired
URL for the pull request review comment
pull_request_review_idintegerrequired
The ID of the pull request review to which the comment belongs.
idintegerrequired
The ID of the pull request review comment.
node_idstringrequired
The node ID of the pull request review comment.
diff_hunkstringrequired
The diff of the line that the comment refers to.
pathstringrequired
The relative path of the file to which the comment applies.
positionintegeroptional
The line index in the diff to which the comment applies. This field is closing down; use `line` instead.
original_positionintegeroptional
The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead.
commit_idstringrequired
The SHA of the commit to which the comment applies.
original_commit_idstringrequired
The SHA of the original commit to which the comment applies.
in_reply_to_idintegeroptional
The comment ID to reply to.
userobjectrequired
A GitHub user.
bodystringrequired
The text of the comment.
created_atstringrequired
updated_atstringrequired
html_urlstringrequired
HTML URL for the pull request review comment.
pull_request_urlstringrequired
URL for the pull request that the review comment belongs to.
author_associationstringrequired
How the author is associated with the repository.
Allowed:COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER
_linksobjectrequired
start_lineintegeroptional
The first line of the range for a multi-line comment.
original_start_lineintegeroptional
The first line of the range for a multi-line comment.
start_sidestringoptional
The side of the first line of the range for a multi-line comment.
Allowed:LEFTRIGHTDefault:RIGHT
lineintegeroptional
The line of the blob to which the comment applies. The last line of the range for a multi-line comment
original_lineintegeroptional
The line of the blob to which the comment applies. The last line of the range for a multi-line comment
sidestringoptional
The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment
Allowed:LEFTRIGHTDefault:RIGHT
subject_typestringoptional
The level at which the comment is targeted, can be a diff line or a file.
Allowed:linefile
reactionsobjectoptional
body_htmlstringoptional
body_textstringoptional