pulls.md

title	intro	redirect_from	versions	topics	miniTocMaxHeadingLevel
Pulls	The Pulls API allows you to list, view, edit, create, and even merge pull requests.	/v3/pulls	fpt ghes ghae ghec * * * *	API	3

The Pull Request API allows you to list, view, edit, create, and even merge pull requests. Comments on pull requests can be managed via the Issue Comments API.

Every pull request is an issue, but not every issue is a pull request. For this reason, "shared" actions for both features, like manipulating assignees, labels and milestones, are provided within the Issues API.

Custom media types for pull requests

These are the supported media types for pull requests.

application/vnd.github.VERSION.raw+json
application/vnd.github.VERSION.text+json
application/vnd.github.VERSION.html+json
application/vnd.github.VERSION.full+json
application/vnd.github.VERSION.diff
application/vnd.github.VERSION.patch

For more information, see "Custom media types."

If a diff is corrupt, contact {% data variables.contact.contact_support %}. Include the repository name and pull request ID in your message.

Link Relations

Pull Requests have these possible link relations:

Name	Description
self	The API location of this Pull Request.
html	The HTML location of this Pull Request.
issue	The API location of this Pull Request's Issue.
comments	The API location of this Pull Request's Issue comments.
review_comments	The API location of this Pull Request's Review comments.
review_comment	The URL template to construct the API location for a Review comment in this Pull Request's repository.
commits	The API location of this Pull Request's commits.
statuses	The API location of this Pull Request's commit statuses, which are the statuses of its head branch.

{% for operation in currentRestOperations %} {% unless operation.subcategory %}{% include rest_operation %}{% endunless %} {% endfor %}

Reviews

Pull Request Reviews are groups of Pull Request Review Comments on the Pull Request, grouped together with a state and optional body comment.

{% for operation in currentRestOperations %} {% if operation.subcategory == 'reviews' %}{% include rest_operation %}{% endif %} {% endfor %}

Review comments

Pull request review comments are comments on a portion of the unified diff made during a pull request review. Commit comments and issue comments are different from pull request review comments. You apply commit comments directly to a commit and you apply issue comments without referencing a portion of the unified diff. For more information, see "Create a commit comment" and "Create an issue comment."

Custom media types for pull request review comments

These are the supported media types for pull request review comments.

application/vnd.github.VERSION.raw+json
application/vnd.github.VERSION.text+json
application/vnd.github.VERSION.html+json
application/vnd.github.VERSION.full+json

For more information, see "Custom media types."

{% for operation in currentRestOperations %} {% if operation.subcategory == 'comments' %}{% include rest_operation %}{% endif %} {% endfor %}

Review requests

Pull request authors and repository owners and collaborators can request a pull request review from anyone with write access to the repository. Each requested reviewer will receive a notification asking them to review the pull request.

{% for operation in currentRestOperations %} {% if operation.subcategory == 'review-requests' %}{% include rest_operation %}{% endif %} {% endfor %}