REST API endpoints for pull requests

Enterprise Cloud

Enterprise Server 3.10

Enterprise Server 3.11

Enterprise Server 3.12

Enterprise Server 3.13

Enterprise Server 3.9

Free, Pro, & Team

REST API

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Help us make these docs great!

Domain name

Who can use this feature?

Actions

Multiple permissions are required, or a different permission may be used. For more information about the permissions, see the documentation for this endpoint.

Enter a search term to find it in the GitHub Docs.

REST API endpoints for pull requests - GitHub Docs

Use the REST API to manage pull requests and pull request reviews.

Quickstart

About the REST API

Comparing GitHub's APIs

API Versions

Breaking changes

OpenAPI description

Getting started

Rate limits

Pagination

Libraries

Best practices

Troubleshooting

Timezones

CORS and JSONP

Issue event types

GitHub event types

Using the REST API

Authenticating

Keeping API credentials secure

Endpoints for GitHub App installation tokens

Endpoints for GitHub App user tokens

Endpoints for fine-grained PATs

Permissions for GitHub Apps

Permissions for fine-grained PATs

Authentication

Script with JavaScript

Script with Ruby

Discover resources for a user

Delivering deployments

Rendering data as graphs

Working with comments

Building a CI server

Get started - Git database

Get started - Checks

Encrypt secrets

Guides

Artifacts

Cache

OIDC

Permissions

Secrets

Self-hosted runners

Variables

Workflow jobs

Workflow runs

Workflows

Events

Feeds

Notifications

Starring

Watching

Activity

GitHub Apps

Installations

Marketplace

OAuth authorizations

Webhooks

Apps

Billing

Branches

Protected branches

Check runs

Check suites

Checks

Classroom

Code scanning

Codes of conduct

Codespaces

Organizations

Organization secrets

Machines

Repository secrets

User secrets

Collaborators

Invitations

Commits

Commit comments

Commit statuses

Copilot usage

Copilot user management

Copilot

Alerts

Dependabot

Dependency review

Dependency submission

Software bill of materials (SBOM)

Dependency graph

Deploy keys

Deployment branch policies

Deployments

Environments

Protection rules

Deployment statuses

Emojis

Gists

Comments

Blobs

References

Trees

Git database

Gitignore

Organization

Repository

User

Interactions

Issues

Assignees

Labels

Milestones

Timeline

Licenses

Markdown

Community

Statistics

Traffic

Metrics

Source endpoints

Users

Migrations

Blocking users

Custom properties

Members

Organization roles

Outside collaborators

Personal access tokens

Rule suites

Rules

Security managers

Packages

Pages

Boards

Cards

Columns

Projects (classic)

Pull requests

Review comments

Review requests

Reviews

Rate limit

Reactions

Releases

Release assets

Autolinks

Forks

Repositories

Search

Secret scanning

Global security advisories

Repository security advisories

Security advisories

Teams

Discussion comments

Discussions

Emails

Followers

GPG keys

Git SSH keys

SSH signing keys

Social accounts

v1.0

Amazing new feature

Pull Request Simple

Lists pull requests in a specified repository.
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 <a href="https://docs.github.com/github/getting-started-with-github/githubs-products">GitHub's products</a>
in the GitHub Help documentation.
This endpoint supports the following custom media types. For more information, see "<a href="https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types">Media types</a>."
<ul>
<li><code>application/vnd.github.raw+json</code>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>
<li><code>application/vnd.github.text+json</code>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>
<li><code>application/vnd.github.html+json</code>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>
<li><code>application/vnd.github.full+json</code>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>
</ul>

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

owner

The name of the repository without the <code>.git</code> extension. The name is not case sensitive.

repo

Either <code>open</code>, <code>closed</code>, or <code>all</code> to filter by state.

state

Filter pulls by head user or head organization and branch name in the format of <code>user:ref-name</code> or <code>organization:ref-name</code>. For example: <code>github:new-script-format</code> or <code>octocat:test-branch</code>.

head

Filter pulls by base branch name. Example: <code>gh-pages</code>.

base

What to sort results by. <code>popularity</code> will sort by the number of comments. <code>long-running</code> will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month.

sort

The direction of the sort. Default: <code>desc</code> when sort is <code>created</code> or sort is not specified, otherwise <code>asc</code>.

direction

The number of results per page (max 100). For more information, see "<a href="https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api">Using pagination in the REST API</a>."

per_page

The page number of the results to fetch. For more information, see "<a href="https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api">Using pagination in the REST API</a>."

page

List pull requests

用于拉取请求的 REST API 端点