Octokit Rest API

Check if a pull request has been merged

octokit.pulls.checkIfMerged({
  owner,
  repo,
  pull_number,
});

Parameters

See also: GitHub Developer Guide documentation.

Create a pull request

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

You can create a new pull request.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

octokit.pulls.create({
  owner,
  repo,
  head,
  base,
});

Parameters

See also: GitHub Developer Guide documentation.

Create a reply for a review comment

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

octokit.pulls.createReplyForReviewComment({
  owner,
  repo,
  pull_number,
  comment_id,
  body,
});

Parameters

See also: GitHub Developer Guide documentation.

Create a review for a pull request

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

Pull request reviews created in the PENDING state do not include the submitted_at property in the response.

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

octokit.pulls.createReview({
        owner,
repo,
pull_number,
comments[].path,
comments[].body
      })

Parameters

See also: GitHub Developer Guide documentation.

Create a review comment for a pull request

Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "Create an issue comment." We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.

You can still create a review comment using the position parameter. When you use position, the line, side, start_line, and start_side parameters are not required. For more information, see the comfort-fade preview notice.

Note: The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

octokit.pulls.createReviewComment({
  owner,
  repo,
  pull_number,
  body,
  path,
});

Parameters

See also: GitHub Developer Guide documentation.

Delete a pending review for a pull request

octokit.pulls.deletePendingReview({
  owner,
  repo,
  pull_number,
  review_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Delete a review comment for a pull request

Deletes a review comment.

octokit.pulls.deleteReviewComment({
  owner,
  repo,
  comment_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Dismiss a review for a pull request

Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.

octokit.pulls.dismissReview({
  owner,
  repo,
  pull_number,
  review_id,
  message,
});

Parameters

See also: GitHub Developer Guide documentation.

Get a pull request

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

Lists details of a pull request by providing its number.

When you get, create, or edit a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see "Checking mergeability of pull requests".

The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.

The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:

• If merged as a merge commit, merge_commit_sha represents the SHA of the merge commit.
• If merged via a squash, merge_commit_sha represents the SHA of the squashed commit on the base branch.
• If rebased, merge_commit_sha represents the commit that the base branch was updated to.

Pass the appropriate media type to fetch diff and patch formats.

octokit.pulls.get({
  owner,
  repo,
  pull_number,
});

Parameters

See also: GitHub Developer Guide documentation.

Get a review for a pull request

octokit.pulls.getReview({
  owner,
  repo,
  pull_number,
  review_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Get a review comment for a pull request

Provides details for a review comment.

octokit.pulls.getReviewComment({
  owner,
  repo,
  comment_id,
});

Parameters

See also: GitHub Developer Guide documentation.

List pull requests

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

octokit.pulls.list({
  owner,
  repo,
});

Parameters

See also: GitHub Developer Guide documentation.

List comments for a pull request review

List comments for a specific pull request review.

octokit.pulls.listCommentsForReview({
  owner,
  repo,
  pull_number,
  review_id,
});

Parameters

See also: GitHub Developer Guide documentation.

List commits on a pull request

Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the List commits endpoint.

octokit.pulls.listCommits({
  owner,
  repo,
  pull_number,
});

Parameters

See also: GitHub Developer Guide documentation.

List pull requests files

Note: Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.

octokit.pulls.listFiles({
  owner,
  repo,
  pull_number,
});

Parameters

See also: GitHub Developer Guide documentation.

List requested reviewers for a pull request

octokit.pulls.listRequestedReviewers({
  owner,
  repo,
  pull_number,
});

Parameters

See also: GitHub Developer Guide documentation.

List review comments on a pull request

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

octokit.pulls.listReviewComments({
  owner,
  repo,
  pull_number,
});

Parameters

See also: GitHub Developer Guide documentation.

List review comments in a repository

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

octokit.pulls.listReviewCommentsForRepo({
  owner,
  repo,
});

Parameters

See also: GitHub Developer Guide documentation.

List reviews for a pull request

The list of reviews returns in chronological order.

octokit.pulls.listReviews({
  owner,
  repo,
  pull_number,
});

Parameters

See also: GitHub Developer Guide documentation.

Merge a pull request

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

octokit.pulls.merge({
  owner,
  repo,
  pull_number,
});

Parameters

See also: GitHub Developer Guide documentation.

Remove requested reviewers from a pull request

octokit.pulls.removeRequestedReviewers({
  owner,
  repo,
  pull_number,
});

Parameters

See also: GitHub Developer Guide documentation.

Request reviewers for a pull request

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

octokit.pulls.requestReviewers({
  owner,
  repo,
  pull_number,
});

Parameters

See also: GitHub Developer Guide documentation.

Submit a review for a pull request

octokit.pulls.submitReview({
  owner,
  repo,
  pull_number,
  review_id,
  event,
});

Parameters

See also: GitHub Developer Guide documentation.

Update a pull request

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

octokit.pulls.update({
  owner,
  repo,
  pull_number,
});

Parameters

See also: GitHub Developer Guide documentation.

Update a pull request branch

Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.

octokit.pulls.updateBranch({
  owner,
  repo,
  pull_number,
});

Parameters

See also: GitHub Developer Guide documentation.

Update a review for a pull request

Update the review summary comment with new text.

octokit.pulls.updateReview({
  owner,
  repo,
  pull_number,
  review_id,
  body,
});

Parameters

See also: GitHub Developer Guide documentation.

Update a review comment for a pull request

Enables you to edit a review comment.

octokit.pulls.updateReviewComment({
  owner,
  repo,
  comment_id,
  body,
});

Parameters

See also: GitHub Developer Guide documentation.