GitHub API (unofficial showcase)

Pulls

Interact with GitHub Pull Requests.

Operations

MethodEndpointDescription
GET/repos/{owner}/{repo}/pullsList pull requests
POST/repos/{owner}/{repo}/pullsCreate a pull request
GET/repos/{owner}/{repo}/pulls/commentsList review comments in a repository
GET/repos/{owner}/{repo}/pulls/comments/{comment_id}Get a review comment for a pull request
PATCH/repos/{owner}/{repo}/pulls/comments/{comment_id}Update a review comment for a pull request
DELETE/repos/{owner}/{repo}/pulls/comments/{comment_id}Delete a review comment for a pull request
GET/repos/{owner}/{repo}/pulls/{pull_number}Get a pull request
PATCH/repos/{owner}/{repo}/pulls/{pull_number}Update a pull request
GET/repos/{owner}/{repo}/pulls/{pull_number}/commentsList review comments on a pull request
POST/repos/{owner}/{repo}/pulls/{pull_number}/commentsCreate a review comment for a pull request
POST/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/repliesCreate a reply for a review comment
GET/repos/{owner}/{repo}/pulls/{pull_number}/commitsList commits on a pull request
GET/repos/{owner}/{repo}/pulls/{pull_number}/filesList pull requests files
GET/repos/{owner}/{repo}/pulls/{pull_number}/mergeCheck if a pull request has been merged
PUT/repos/{owner}/{repo}/pulls/{pull_number}/mergeMerge a pull request
GET/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewersGet all requested reviewers for a pull request
POST/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewersRequest reviewers for a pull request
DELETE/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewersRemove requested reviewers from a pull request
GET/repos/{owner}/{repo}/pulls/{pull_number}/reviewsList reviews for a pull request
POST/repos/{owner}/{repo}/pulls/{pull_number}/reviewsCreate a review for a pull request
GET/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}Get a review for a pull request
PUT/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}Update a review for a pull request
DELETE/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}Delete a pending review for a pull request
GET/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/commentsList comments for a pull request review
PUT/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissalsDismiss a review for a pull request
POST/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/eventsSubmit a review for a pull request
PUT/repos/{owner}/{repo}/pulls/{pull_number}/update-branchUpdate a pull request branch

Example

List pull requests, with the TypeScript SDK:

ts
import { GitHubV3REST } from "github";

const client = new GitHubV3REST({
  baseUrl: "https://api.github.com",
});

const result = await client.pulls.list({
  owner: "owner",
  repo: "repo",
});
console.log(result);
Nine more languages

The same call exists in every SDK. See SDKs for the other nine.