Pulls

Enterprise Cloud

Enterprise Server

Enterprise Server 3.10

Enterprise Server 3.6

Enterprise Server 3.7

Enterprise Server 3.8

Enterprise Server 3.9

Free, Pro, & Team

GitHub AE

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!

Help for wherever you are on your GitHub journey.

Can be one of

Name

All {{ name }} guides

{{ name }} learning paths

Actions

GitHub began rolling these changes out to enterprises on

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

Pulls - GitHub AE Docs

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

English

Simplified Chinese

Spanish

Portuguese

Russian

Japanese

French

German

Korean

Quickstart

About GitHub's APIs

Resources in the REST API

Media types

Authenticating

Keeping API credentials secure

Troubleshooting

Libraries

Issue event types

GitHub event types

Endpoints for GitHub App installation tokens

Endpoints for GitHub App user tokens

Permissions for GitHub Apps

Overview

Using the API

Script with JavaScript

Discover resources for a user

Delivering deployments

Rendering data as graphs

Working with comments

Pagination

Building a CI server

Best practices

Get started - Git database

Get started - Checks

Encrypt secrets

Guides

Artifacts

Permissions

Secrets

Self-hosted runner groups

Self-hosted runners

Workflow jobs

Workflow runs

Workflows

Events

Feeds

Notifications

Starring

Watching

Activity

GitHub Apps

Installations

OAuth Authorizations

Webhooks

Apps

Branches

Protected branches

Check Runs

Check Suites

Checks

Codes of conduct

Code Scanning

Collaborators

Invitations

Commits

Commit comments

Commit statuses

Deploy keys

Deployment branch policies

Deployments

Environments

Deployment statuses

Emojis

Admin stats

Announcement

Audit log

Global Webhooks

License

Organizations

Pre-receive Environments

Users

Enterprise administration

Gists

Comments

Blobs

References

Trees

Git database

Gitignore

Issues

Assignees

Labels

Milestones

Timeline

Licenses

Markdown

Statistics

Metrics

Migrations

Members

Outside Collaborators

Pages

Boards

Cards

Columns

Project boards

Review comments

Review requests

Reviews

Rate limit

Reactions

Releases

Release Assets

Autolinks

Forks

Git LFS

Repositories

Search

Secret scanning

Teams

Discussion comments

Discussions

External groups

Followers

GPG Keys

Git SSH Keys

Repository Webhook Configuration

Repository Webhook Deliveries

Repository Webhooks

Repository webhooks

v1.0

Amazing new feature

Pull Request Simple

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-ae@latest/github/getting-started-with-github/githubs-products">GitHub's products</a> in the GitHub Help documentation.

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).

per_page

Page number of the results to fetch.

page

Validation failed, or the endpoint has been spammed.

List pull requests

The title of the new pull request. Required unless <code>issue</code> is specified.

title

The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace <code>head</code> with a user like this: <code>username:branch</code>.

The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.

body

Indicates whether <a href="https://docs.github.com/github-ae@latest/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/">maintainers can modify</a> the pull request.

maintainer_can_modify

Indicates whether the pull request is a draft. See "<a href="https://docs.github.com/github-ae@latest/articles/about-pull-requests#draft-pull-requests">Draft Pull Requests</a>" in the GitHub Help documentation to learn more.

draft

An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless <code>title</code> is specified.

issue

https://api.github.com/repos/octocat/Hello-World/contents/{+path}

Hello-World

Justice League

Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.

How the author is associated with the repository.

author_association

The status of auto merging a pull request.

Auto merge

Indicates whether or not the pull request is a draft.

Indicates whether maintainers can modify the pull request.

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 <a href="https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products">GitHub's products</a> 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.
This endpoint triggers <a href="https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See "<a href="https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits">Secondary rate limits</a>" and "<a href="https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-rate-limits">Dealing with secondary rate limits</a>" for details.

Create a pull request