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

List comments for a pull request review

Lists comments for a specific pull request review.

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.

6 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.
review_idintegerrequired
The unique identifier of the review.
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

2 status codes
200Response
urlstringrequired
pull_request_review_idintegerrequired
idintegerrequired
node_idstringrequired
diff_hunkstringrequired
pathstringrequired
positionintegerrequired
original_positionintegerrequired
commit_idstringrequired
original_commit_idstringrequired
in_reply_to_idintegeroptional
userobjectrequired
A GitHub user.
bodystringrequired
created_atstringrequired
updated_atstringrequired
html_urlstringrequired
pull_request_urlstringrequired
author_associationstringrequired
How the author is associated with the repository.
Allowed:COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER
_linksobjectrequired
body_textstringoptional
body_htmlstringoptional
reactionsobjectoptional
sidestringoptional
The side of the first line of the range for a multi-line comment.
Allowed:LEFTRIGHTDefault:RIGHT
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 original line of the blob to which the comment applies. The last line of the range for a multi-line comment
start_lineintegeroptional
The first line of the range for a multi-line comment.
original_start_lineintegeroptional
The original first line of the range for a multi-line comment.
subject_typestringoptional
The level at which the comment is targeted, can be a diff line or a file.
Allowed:linefile
404Resource not found
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional

Error handling

A 404 is returned: Resource not found.