content/rest/pulls/pulls.md

metadata

title: REST API endpoints for pull requests
shortTitle: Pull requests
allowTitleToDifferFromFilename: true
intro: Use the REST API to interact with pull requests.
versions:
  fpt: '*'
  ghec: '*'
  ghes: '*'
topics:
  - API
autogenerated: rest

About pull requests

You can list, view, edit, create, and merge pull requests using the REST API. For information about how to interact with comments on a pull request, see AUTOTITLE.

Pull requests are a type of issue. Any actions that are available in both pull requests and issues, like managing assignees, labels, and milestones, are handled by the REST API to manage issues. To perform these actions on pull requests, you must use the issues API endpoints (for example, /repos/{owner}/{repo}/issues/{issue_number}), not the pull requests endpoints. For more information, see AUTOTITLE.

Link Relations

Pull requests have these possible link relations:

• 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