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

List review comments in a repository

Lists review comments from all pull requests in a repository. Use sort, direction, and since to control ordering and filter comments updated after a specified time. Use page and per_page to paginate the results; the response format can include raw, text, or HTML comment representations based on the requested media type.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

7 parameters
ownerstringrequired
The account owner of the repository; the name is not case sensitive.
repostringrequired
The repository name without the `.git` extension; the name is not case sensitive.
sortstringoptional
The property used to sort review comments: `created`, `updated`, or `created_at`.
Allowed:createdupdatedcreated_at
directionstringoptional
The sort direction: `asc` or `desc`. Ignored when `sort` is omitted.
Allowed:ascdesc
sincestringoptional
Return only comments last updated after this timestamp in ISO 8601 date-time format.
per_pageintegeroptional
The number of review comments to return per page, up to 100. Defaults to 30 when omitted.
Default:30
pageintegeroptional
The page number of results to retrieve. Defaults to 1 when omitted.
Default:1

1 status code
200Returns an array of pull request review comment objects, including comment identifiers, associated pull request review, diff location, commit references, author, body, and creation and update timestamps.
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

Error handling

owner and repo must identify the repository whose review comments you want to list. sort must be one of created, updated, or created_at, and direction must be asc or desc; direction is ignored when sort is omitted. since must be an ISO 8601 date-time, per_page must not exceed 100, and page identifies the page to retrieve.