Sign in

v50

latestOpenAPI 3.0.3MITraw.githubusercontent.com2023-11-288093493.9 MB
pulls

List reviews for a pull request

The list of reviews returns in chronological order.

get/repos/{owner}/{repo}/pulls/{pull_number}/reviews

Path parameters

ownerstring required

The account owner of the repository. The name is not case sensitive.

repostring required

The name of the repository without the .git extension. The name is not case sensitive.

pull_numberinteger required

The number that identifies the pull request.

Query parameters

per_pageinteger

The number of results per page (max 100).

pageinteger

Page number of the results to fetch.

Response

The list of reviews returns in chronological order.

idinteger required

Unique identifier of the review

node_idstring required
bodystring required

The text of the review.

statestring required
html_urlstring uri required
pull_request_urlstring uri required
submitted_atstring date-time
commit_idstring nullable required

A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be null.

body_htmlstring
body_textstring
author_association'COLLABORATOR' | 'CONTRIBUTOR' | 'FIRST_TIMER' | 'FIRST_TIME_CONTRIBUTOR' | 'MANNEQUIN' | 'MEMBER' | 'NONE' | 'OWNER' required

How the author is associated with the repository.

Example response

[
  {
    "id": 42,
    "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=",
    "user": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "starred_at": "\"2020-07-09T00:17:55Z\""
    },
    "body": "This looks great.",
    "state": "CHANGES_REQUESTED",
    "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80",
    "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12",
    "commit_id": "54bb654c9e6025347f57900a4a5c2313a96b8035",
    "author_association": "OWNER"
  }
]