Skip to main content
Manja / GitHub

List comments for a pull request review

List comments for a specific pull request review.

GET/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments
Source
github-v3-rest.json
Revision
f5f067c1e6f6
Active snapshot
85e53e3d0d65

Request

Path Parameters
owner string
required
repo string
required
pull_number integer
required
review_id integer
required

review_id parameter

Query Parameters
per_page integer
optional

Results per page (max 100)

page integer
optional

Page number of the results to fetch.

Responses

application/json array[Legacy Review Comment object]

Response

Headers
Link string
Example:
<https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; rel="last"
items Legacy Review Comment object

Legacy Review Comment

_links object
required
html Link object
required

Hypermedia Link

href string
required
pull_request Link object
required

Hypermedia Link

href string
required
self Link object
required

Hypermedia Link

href string
required
author_association
string< author_association >
required

How the author is associated with the repository.

Example: OWNER

Allowed: "COLLABORATOR""CONTRIBUTOR""FIRST_TIMER""FIRST_TIME_CONTRIBUTOR""MANNEQUIN""MEMBER""NONE""OWNER"

body string
required

Example: Great stuff

body_html string
optional
body_text string
optional
commit_id string
required

Example: 6dcb09b5b57875f334f61aebed695e2e4193db5e

created_at string<date-time>
required

Example: 2011-04-14T16:00:49Z

diff_hunk string
required

Example: @@ -16,33 +16,40 @@ public class Connection : IConnection...

html_url string<uri>
required

Example: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1

id integer
required

Example: 10

in_reply_to_id integer
optional

Example: 8

line integer
optional

The line of the blob to which the comment applies. The last line of the range for a multi-line comment

Example: 2

node_id string
required

Example: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw

original_commit_id string
required

Example: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840

original_line integer
optional

The original line of the blob to which the comment applies. The last line of the range for a multi-line comment

Example: 2

original_position integer
required

Example: 4

original_start_line integer
optionalnullable

The original first line of the range for a multi-line comment.

Example: 2

path string
required

Example: file1.txt

position integer
requirednullable

Example: 1

pull_request_review_id integer
requirednullable

Example: 42

pull_request_url string<uri>
required

Example: https://api.github.com/repos/octocat/Hello-World/pulls/1

reactions Reaction Rollup object
optional
+1 integer
required
-1 integer
required
confused integer
required
eyes integer
required
heart integer
required
hooray integer
required
laugh integer
required
rocket integer
required
total_count integer
required
url string<uri>
required
side string
optional

The side of the first line of the range for a multi-line comment.

Default: RIGHT

Allowed: "LEFT""RIGHT"

start_line integer
optionalnullable

The first line of the range for a multi-line comment.

Example: 2

start_side string
optionalnullable

The side of the first line of the range for a multi-line comment.

Default: RIGHT

Allowed: "LEFT""RIGHT"

updated_at string<date-time>
required

Example: 2011-04-14T16:00:49Z

url string<uri>
required

Example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1

user Simple User object
requirednullable

Simple User

avatar_url string<uri>
required

Example: https://github.com/images/error/octocat_happy.gif

email string
optionalnullable
events_url string
required

Example: https://api.github.com/users/octocat/events{/privacy}

followers_url string<uri>
required

Example: https://api.github.com/users/octocat/followers

following_url string
required

Example: https://api.github.com/users/octocat/following{/other_user}

gists_url string
required

Example: https://api.github.com/users/octocat/gists{/gist_id}

gravatar_id string
requirednullable

Example: 41d064eb2195891e12d0413f63227ea7

html_url string<uri>
required

Example: https://github.com/octocat

id integer
required

Example: 1

login string
required

Example: octocat

name string
optionalnullable
node_id string
required

Example: MDQ6VXNlcjE=

organizations_url string<uri>
required

Example: https://api.github.com/users/octocat/orgs

received_events_url string<uri>
required

Example: https://api.github.com/users/octocat/received_events

repos_url string<uri>
required

Example: https://api.github.com/users/octocat/repos

site_admin boolean
required
starred_at string
optional

Example: "2020-07-09T00:17:55Z"

starred_url string
required

Example: https://api.github.com/users/octocat/starred{/owner}{/repo}

subscriptions_url string<uri>
required

Example: https://api.github.com/users/octocat/subscriptions

type string
required

Example: User

url string<uri>
required

Example: https://api.github.com/users/octocat

application/json Basic Error object

Resource not found

documentation_url string
optional
message string
optional
status string
optional
url string
optional