GitHub API
  1. pulls
GitHub API
  • meta
    • GitHub API Root
      GET
    • Get GitHub Enterprise Server meta information
      GET
    • Get Octocat
      GET
    • Get the Zen of GitHub
      GET
  • enterprise-admin
    • List global webhooks
    • Create a global webhook
    • Delete a global webhook
    • Get a global webhook
    • Update a global webhook
    • Ping a global webhook
    • List public keys
    • Delete a public key
    • Update LDAP mapping for a team
    • Sync LDAP mapping for a team
    • Update LDAP mapping for a user
    • Sync LDAP mapping for a user
    • Create an organization
    • Update an organization name
    • List pre-receive environments
    • Create a pre-receive environment
    • Delete a pre-receive environment
    • Get a pre-receive environment
    • Update a pre-receive environment
    • Start a pre-receive environment download
    • Get the download status for a pre-receive environment
    • List pre-receive hooks
    • Create a pre-receive hook
    • Delete a pre-receive hook
    • Get a pre-receive hook
    • Update a pre-receive hook
    • List personal access tokens
    • Delete a personal access token
    • Create a user
    • Delete a user
    • Update the username for a user
    • Delete an impersonation OAuth token
    • Create an impersonation OAuth token
    • Get license information
    • Get statistics
    • List self-hosted runner groups for an enterprise
    • Create a self-hosted runner group for an enterprise
    • Delete a self-hosted runner group from an enterprise
    • Get a self-hosted runner group for an enterprise
    • Update a self-hosted runner group for an enterprise
    • List organization access to a self-hosted runner group in an enterprise
    • Set organization access for a self-hosted runner group in an enterprise
    • Remove organization access to a self-hosted runner group in an enterprise
    • Add organization access to a self-hosted runner group in an enterprise
    • List self-hosted runners in a group for an enterprise
    • Set self-hosted runners in a group for an enterprise
    • Remove a self-hosted runner from a group for an enterprise
    • Add a self-hosted runner to a group for an enterprise
    • List self-hosted runners for an enterprise
    • List runner applications for an enterprise
    • Create a registration token for an enterprise
    • Create a remove token for an enterprise
    • Delete a self-hosted runner from an enterprise
    • Get a self-hosted runner for an enterprise
    • List pre-receive hooks for an organization
    • Remove pre-receive hook enforcement for an organization
    • Get a pre-receive hook for an organization
    • Update pre-receive hook enforcement for an organization
    • List pre-receive hooks for a repository
    • Remove pre-receive hook enforcement for a repository
    • Get a pre-receive hook for a repository
    • Update pre-receive hook enforcement for a repository
    • Get the configuration status
    • Start a configuration process
    • Get the maintenance status
    • Enable or disable maintenance mode
    • Get settings
    • Set settings
    • Remove an authorized SSH key
    • Get all authorized SSH keys
    • Add an authorized SSH key
    • Create a GitHub license
    • Upgrade a license
    • Demote a site administrator
    • Promote a user to be a site administrator
    • Unsuspend a user
    • Suspend a user
  • apps
    • Get the authenticated app
    • Create a GitHub App from a manifest
    • List installations for the authenticated app
    • Delete an installation for the authenticated app
    • Get an installation for the authenticated app
    • Create an installation access token for an app
    • Unsuspend an app installation
    • Suspend an app installation
    • Delete an app authorization
    • Revoke a grant for an application
    • Delete an app token
    • Reset a token
    • Check a token
    • Revoke an authorization for an application
    • Check an authorization
    • Reset an authorization
    • Get an app
    • List repositories accessible to the app installation
    • Revoke an installation access token
    • Get an organization installation for the authenticated app
    • Create a content attachment
    • Get a repository installation for the authenticated app
    • List app installations accessible to the user access token
    • List repositories accessible to the user access token
    • Remove a repository from an app installation
    • Add a repository to an app installation
    • Get a user installation for the authenticated app
  • oauth-authorizations
    • List your grants
    • Delete a grant
    • Get a single grant
    • List your authorizations
    • Create a new authorization
    • Get-or-create an authorization for a specific app
    • Get-or-create an authorization for a specific app and fingerprint
    • Delete an authorization
    • Get a single authorization
    • Update an existing authorization
  • codes-of-conduct
    • Get all codes of conduct
    • Get a code of conduct
  • emojis
    • Get emojis
  • activity
    • List public events
    • Get feeds
    • List public events for a network of repositories
    • List notifications for the authenticated user
    • Mark notifications as read
    • Get a thread
    • Mark a thread as read
    • Delete a thread subscription
    • Get a thread subscription for the authenticated user
    • Set a thread subscription
    • List public organization events
    • List repository events
    • List repository notifications for the authenticated user
    • Mark repository notifications as read
    • List stargazers
    • List watchers
    • Delete a repository subscription
    • Get a repository subscription
    • Set a repository subscription
    • List repositories starred by the authenticated user
    • Unstar a repository for the authenticated user
    • Check if a repository is starred by the authenticated user
    • Star a repository for the authenticated user
    • List repositories watched by the authenticated user
    • List events for the authenticated user
    • List organization events for the authenticated user
    • List public events for a user
    • List events received by the authenticated user
    • List public events received by a user
    • List repositories starred by a user
    • List repositories watched by a user
  • gists
    • List gists for the authenticated user
    • Create a gist
    • List public gists
    • List starred gists
    • Delete a gist
    • Get a gist
    • Update a gist
    • List gist comments
    • Create a gist comment
    • Delete a gist comment
    • Get a gist comment
    • Update a gist comment
    • List gist commits
    • List gist forks
    • Fork a gist
    • Unstar a gist
    • Check if a gist is starred
    • Star a gist
    • Get a gist revision
    • List gists for a user
  • gitignore
    • Get all gitignore templates
    • Get a gitignore template
  • issues
    • List issues assigned to the authenticated user
    • List organization issues assigned to the authenticated user
    • List assignees
    • Check if a user can be assigned
    • List repository issues
    • Create an issue
    • List issue comments for a repository
    • Delete an issue comment
    • Get an issue comment
    • Update an issue comment
    • List issue events for a repository
    • Get an issue event
    • Get an issue
    • Update an issue
    • Remove assignees from an issue
    • Add assignees to an issue
    • List issue comments
    • Create an issue comment
    • List issue events
    • Remove all labels from an issue
    • List labels for an issue
    • Add labels to an issue
    • Set labels for an issue
    • Remove a label from an issue
    • Unlock an issue
    • Lock an issue
    • List timeline events for an issue
    • List labels for a repository
    • Create a label
    • Delete a label
    • Get a label
    • Update a label
    • List milestones
    • Create a milestone
    • Delete a milestone
    • Get a milestone
    • Update a milestone
    • List labels for issues in a milestone
    • List user account issues assigned to the authenticated user
  • licenses
    • Get all commonly used licenses
    • Get a license
    • Get the license for a repository
  • markdown
    • Render a Markdown document
    • Render a Markdown document in raw mode
  • orgs
    • List organizations
    • Get an organization
    • Update an organization
    • List organization webhooks
    • Create an organization webhook
    • Delete an organization webhook
    • Get an organization webhook
    • Update an organization webhook
    • Ping an organization webhook
    • List app installations for an organization
    • List organization members
    • Remove an organization member
    • Check organization membership for a user
    • Remove organization membership for a user
    • Get organization membership for a user
    • Set organization membership for a user
    • List outside collaborators for an organization
    • Remove outside collaborator from an organization
    • Convert an organization member to outside collaborator
    • List public organization members
    • Remove public organization membership for the authenticated user
    • Check public organization membership for a user
    • Set public organization membership for the authenticated user
    • List organization memberships for the authenticated user
    • Get an organization membership for the authenticated user
    • Update an organization membership for the authenticated user
    • List organizations for the authenticated user
    • List organizations for a user
  • actions
    • List self-hosted runner groups for an organization
    • Create a self-hosted runner group for an organization
    • Delete a self-hosted runner group from an organization
    • Get a self-hosted runner group for an organization
    • Update a self-hosted runner group for an organization
    • List repository access to a self-hosted runner group in an organization
    • Set repository access for a self-hosted runner group in an organization
    • Remove repository access to a self-hosted runner group in an organization
    • Add repository access to a self-hosted runner group in an organization
    • List self-hosted runners in a group for an organization
    • Set self-hosted runners in a group for an organization
    • Remove a self-hosted runner from a group for an organization
    • Add a self-hosted runner to a group for an organization
    • List self-hosted runners for an organization
    • List runner applications for an organization
    • Create a registration token for an organization
    • Create a remove token for an organization
    • Delete a self-hosted runner from an organization
    • Get a self-hosted runner for an organization
    • List organization secrets
    • Get an organization public key
    • Delete an organization secret
    • Get an organization secret
    • Create or update an organization secret
    • List selected repositories for an organization secret
    • Set selected repositories for an organization secret
    • Remove selected repository from an organization secret
    • Add selected repository to an organization secret
    • List artifacts for a repository
    • Delete an artifact
    • Get an artifact
    • Download an artifact
    • Get a job for a workflow run
    • Download job logs for a workflow run
    • List self-hosted runners for a repository
    • List runner applications for a repository
    • Create a registration token for a repository
    • Create a remove token for a repository
    • Delete a self-hosted runner from a repository
    • Get a self-hosted runner for a repository
    • List workflow runs for a repository
    • Delete a workflow run
    • Get a workflow run
    • List workflow run artifacts
    • Cancel a workflow run
    • List jobs for a workflow run
    • Delete workflow run logs
    • Download workflow run logs
    • Re-run a workflow
    • List repository secrets
    • Get a repository public key
    • Delete a repository secret
    • Get a repository secret
    • Create or update a repository secret
    • List repository workflows
    • Get a workflow
    • Create a workflow dispatch event
    • List workflow runs
  • projects
    • List organization projects
    • Create an organization project
    • Delete a project card
    • Get a project card
    • Update an existing project card
    • Move a project card
    • Delete a project column
    • Get a project column
    • Update an existing project column
    • List project cards
    • Create a project card
    • Move a project column
    • Delete a project
    • Get a project
    • Update a project
    • List project collaborators
    • Remove user as a collaborator
    • Add project collaborator
    • Get project permission for a user
    • List project columns
    • Create a project column
    • List repository projects
    • Create a repository project
    • Create a user project
    • List user projects
  • repos
    • List organization repositories
    • Create an organization repository
    • Delete a repository
    • Get a repository
    • Update a repository
    • List branches
    • Get a branch
    • Delete branch protection
    • Get branch protection
    • Update branch protection
    • Delete admin branch protection
    • Get admin branch protection
    • Set admin branch protection
    • Delete pull request review protection
    • Get pull request review protection
    • Update pull request review protection
    • Delete commit signature protection
    • Get commit signature protection
    • Create commit signature protection
    • Remove status check protection
    • Get status checks protection
    • Update status check protection
    • Remove status check contexts
    • Get all status check contexts
    • Add status check contexts
    • Set status check contexts
    • Delete access restrictions
    • Get access restrictions
    • Remove app access restrictions
    • Get apps with access to the protected branch
    • Add app access restrictions
    • Set app access restrictions
    • Remove team access restrictions
    • Get teams with access to the protected branch
    • Add team access restrictions
    • Set team access restrictions
    • Remove user access restrictions
    • Get users with access to the protected branch
    • Add user access restrictions
    • Set user access restrictions
    • List repository collaborators
    • Remove a repository collaborator
    • Check if a user is a repository collaborator
    • Add a repository collaborator
    • Get repository permissions for a user
    • List commit comments for a repository
    • Delete a commit comment
    • Get a commit comment
    • Update a commit comment
    • List commits
    • List branches for HEAD commit
    • List commit comments
    • Create a commit comment
    • List pull requests associated with a commit
    • Get a commit
    • Get the combined status for a specific reference
    • List commit statuses for a reference
    • Compare two commits
    • Delete a file
    • Get repository content
    • Create or update file contents
    • List repository contributors
    • List deployments
    • Create a deployment
    • Delete a deployment
    • Get a deployment
    • List deployment statuses
    • Create a deployment status
    • Get a deployment status
    • Create a repository dispatch event
    • List forks
    • Create a fork
    • List repository webhooks
    • Create a repository webhook
    • Delete a repository webhook
    • Get a repository webhook
    • Update a repository webhook
    • Ping a repository webhook
    • Test the push repository webhook
    • List repository invitations
    • Delete a repository invitation
    • Update a repository invitation
    • List deploy keys
    • Create a deploy key
    • Delete a deploy key
    • Get a deploy key
    • List repository languages
    • Merge a branch
    • Delete a GitHub Enterprise Server Pages site
    • Get a GitHub Enterprise Server Pages site
    • Create a GitHub Enterprise Server Pages site
    • Update information about a GitHub Enterprise Server Pages site
    • List GitHub Enterprise Server Pages builds
    • Request a GitHub Enterprise Server Pages build
    • Get latest Pages build
    • Get GitHub Enterprise Server Pages build
    • Get a repository README
    • Get a repository README for a directory
    • List releases
    • Create a release
    • Delete a release asset
    • Get a release asset
    • Update a release asset
    • Get the latest release
    • Get a release by tag name
    • Delete a release
    • Get a release
    • Update a release
    • List release assets
    • Upload a release asset
    • Get the weekly commit activity
    • Get the last year of commit activity
    • Get all contributor commit activity
    • Get the weekly commit count
    • Get the hourly commit count for each day
    • Create a commit status
    • List repository tags
    • Download a repository archive (tar)
    • List repository teams
    • Get all repository topics
    • Replace all repository topics
    • Transfer a repository
    • Download a repository archive (zip)
    • Create a repository using a template
    • List public repositories
    • List repositories for the authenticated user
    • Create a repository for the authenticated user
    • List repository invitations for the authenticated user
    • Decline a repository invitation
    • Accept a repository invitation
    • List repositories for a user
  • teams
    • List teams
    • Create a team
    • Delete a team
    • Get a team by name
    • Update a team
    • List discussions
    • Create a discussion
    • Delete a discussion
    • Get a discussion
    • Update a discussion
    • List discussion comments
    • Create a discussion comment
    • Delete a discussion comment
    • Get a discussion comment
    • Update a discussion comment
    • List team members
    • Remove team membership for a user
    • Get team membership for a user
    • Add or update team membership for a user
    • List team projects
    • Remove a project from a team
    • Check team permissions for a project
    • Add or update team project permissions
    • List team repositories
    • Remove a repository from a team
    • Check team permissions for a repository
    • Add or update team repository permissions
    • List child teams
    • Delete a team (Legacy)
    • Get a team (Legacy)
    • Update a team (Legacy)
    • List discussions (Legacy)
    • Create a discussion (Legacy)
    • Delete a discussion (Legacy)
    • Get a discussion (Legacy)
    • Update a discussion (Legacy)
    • List discussion comments (Legacy)
    • Create a discussion comment (Legacy)
    • Delete a discussion comment (Legacy)
    • Get a discussion comment (Legacy)
    • Update a discussion comment (Legacy)
    • List team members (Legacy)
    • Remove team member (Legacy)
    • Get team member (Legacy)
    • Add team member (Legacy)
    • Remove team membership for a user (Legacy)
    • Get team membership for a user (Legacy)
    • Add or update team membership for a user (Legacy)
    • List team projects (Legacy)
    • Remove a project from a team (Legacy)
    • Check team permissions for a project (Legacy)
    • Add or update team project permissions (Legacy)
    • List team repositories (Legacy)
    • Remove a repository from a team (Legacy)
    • Check team permissions for a repository (Legacy)
    • Add or update team repository permissions (Legacy)
    • List child teams (Legacy)
    • List teams for the authenticated user
  • reactions
    • List reactions for a team discussion comment
    • Create reaction for a team discussion comment
    • Delete team discussion comment reaction
    • List reactions for a team discussion
    • Create reaction for a team discussion
    • Delete team discussion reaction
    • Delete a reaction (Legacy)
    • List reactions for a commit comment
    • Create reaction for a commit comment
    • Delete a commit comment reaction
    • List reactions for an issue comment
    • Create reaction for an issue comment
    • Delete an issue comment reaction
    • List reactions for an issue
    • Create reaction for an issue
    • Delete an issue reaction
    • List reactions for a pull request review comment
    • Create reaction for a pull request review comment
    • Delete a pull request comment reaction
    • List reactions for a team discussion comment (Legacy)
    • Create reaction for a team discussion comment (Legacy)
    • List reactions for a team discussion (Legacy)
    • Create reaction for a team discussion (Legacy)
  • rate-limit
    • Get rate limit status for the authenticated user
  • checks
    • Create a check run
    • Get a check run
    • Update a check run
    • List check run annotations
    • Create a check suite
    • Update repository preferences for check suites
    • Get a check suite
    • List check runs in a check suite
    • Rerequest a check suite
    • List check runs for a Git reference
    • List check suites for a Git reference
  • code-scanning
    • List code scanning alerts for a repository
    • Get a code scanning alert
    • Update a code scanning alert
    • List code scanning analyses for a repository
    • Upload an analysis as SARIF data
  • git
    • Create a blob
    • Get a blob
    • Create a commit
    • Get a commit
    • List matching references
    • Get a reference
    • Create a reference
    • Delete a reference
    • Update a reference
    • Create a tag object
    • Get a tag
    • Create a tree
    • Get a tree
  • pulls
    • List pull requests
      GET
    • Create a pull request
      POST
    • List review comments in a repository
      GET
    • Delete a review comment for a pull request
      DELETE
    • Get a review comment for a pull request
      GET
    • Update a review comment for a pull request
      PATCH
    • Get a pull request
      GET
    • Update a pull request
      PATCH
    • List review comments on a pull request
      GET
    • Create a review comment for a pull request
      POST
    • Create a reply for a review comment
      POST
    • List commits on a pull request
      GET
    • List pull requests files
      GET
    • Check if a pull request has been merged
      GET
    • Merge a pull request
      PUT
    • Remove requested reviewers from a pull request
      DELETE
    • List requested reviewers for a pull request
      GET
    • Request reviewers for a pull request
      POST
    • List reviews for a pull request
      GET
    • Create a review for a pull request
      POST
    • Delete a pending review for a pull request
      DELETE
    • Get a review for a pull request
      GET
    • Update a review for a pull request
      PUT
    • List comments for a pull request review
      GET
    • Dismiss a review for a pull request
      PUT
    • Submit a review for a pull request
      POST
    • Update a pull request branch
      PUT
  • search
    • Search code
    • Search commits
    • Search issues and pull requests
    • Search labels
    • Search repositories
    • Search topics
    • Search users
  • users
    • Get the authenticated user
    • Update the authenticated user
    • Delete an email address for the authenticated user
    • List email addresses for the authenticated user
    • Add an email address for the authenticated user
    • List followers of the authenticated user
    • List the people the authenticated user follows
    • Unfollow a user
    • Check if a person is followed by the authenticated user
    • Follow a user
    • List GPG keys for the authenticated user
    • Create a GPG key for the authenticated user
    • Delete a GPG key for the authenticated user
    • Get a GPG key for the authenticated user
    • List public SSH keys for the authenticated user
    • Create a public SSH key for the authenticated user
    • Delete a public SSH key for the authenticated user
    • Get a public SSH key for the authenticated user
    • List public email addresses for the authenticated user
    • List users
    • Get a user
    • List followers of a user
    • List the people a user follows
    • Check if a user follows another user
    • List GPG keys for a user
    • Get contextual information for a user
    • List public keys for a user
  • billing
  • interactions
  • migrations
  1. pulls

Create a pull request

POST
/repos/{owner}/{repo}/pulls
pulls
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 GitHub's products 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.
You can create a new pull request.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.github.com/repos///pulls' \
--header 'Content-Type: application/json' \
--data-raw '{
    "base": "master",
    "body": "Please pull these awesome changes in!",
    "head": "octocat:new-feature",
    "title": "Amazing new feature"
}'
响应示例响应示例
201 - 示例 1
{
  "_links": {
    "comments": {
      "href": "string"
    },
    "commits": {
      "href": "string"
    },
    "html": {
      "href": "string"
    },
    "issue": {
      "href": "string"
    },
    "review_comment": {
      "href": "string"
    },
    "review_comments": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "statuses": {
      "href": "string"
    }
  },
  "active_lock_reason": "too heated",
  "additions": 100,
  "assignee": {
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
    "html_url": "https://github.com/octocat",
    "id": 1,
    "login": "octocat",
    "node_id": "MDQ6VXNlcjE=",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "site_admin": true,
    "starred_at": "\"2020-07-09T00:17:55Z\"",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "type": "User",
    "url": "https://api.github.com/users/octocat"
  },
  "assignees": [
    {
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
      "html_url": "https://github.com/octocat",
      "id": 1,
      "login": "octocat",
      "node_id": "MDQ6VXNlcjE=",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "site_admin": true,
      "starred_at": "\"2020-07-09T00:17:55Z\"",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "type": "User",
      "url": "https://api.github.com/users/octocat"
    }
  ],
  "author_association": "OWNER",
  "base": {
    "label": "string",
    "ref": "string",
    "repo": {
      "allow_merge_commit": true,
      "allow_rebase_merge": true,
      "allow_squash_merge": true,
      "archive_url": "string",
      "archived": true,
      "assignees_url": "string",
      "blobs_url": "string",
      "branches_url": "string",
      "clone_url": "string",
      "collaborators_url": "string",
      "comments_url": "string",
      "commits_url": "string",
      "compare_url": "string",
      "contents_url": "string",
      "contributors_url": "http://example.com",
      "created_at": "2019-08-24T14:15:22Z",
      "default_branch": "string",
      "deployments_url": "http://example.com",
      "description": "string",
      "disabled": true,
      "downloads_url": "http://example.com",
      "events_url": "http://example.com",
      "fork": true,
      "forks": 0,
      "forks_count": 0,
      "forks_url": "http://example.com",
      "full_name": "string",
      "git_commits_url": "string",
      "git_refs_url": "string",
      "git_tags_url": "string",
      "git_url": "string",
      "has_downloads": true,
      "has_issues": true,
      "has_pages": true,
      "has_projects": true,
      "has_wiki": true,
      "homepage": "http://example.com",
      "hooks_url": "http://example.com",
      "html_url": "http://example.com",
      "id": 0,
      "issue_comment_url": "string",
      "issue_events_url": "string",
      "issues_url": "string",
      "keys_url": "string",
      "labels_url": "string",
      "language": "string",
      "languages_url": "http://example.com",
      "license": {
        "html_url": "http://example.com",
        "key": "mit",
        "name": "MIT License",
        "node_id": "MDc6TGljZW5zZW1pdA==",
        "spdx_id": "MIT",
        "url": "https://api.github.com/licenses/mit"
      },
      "master_branch": "string",
      "merges_url": "http://example.com",
      "milestones_url": "string",
      "mirror_url": "http://example.com",
      "name": "string",
      "node_id": "string",
      "notifications_url": "string",
      "open_issues": 0,
      "open_issues_count": 0,
      "owner": {
        "avatar_url": "http://example.com",
        "events_url": "string",
        "followers_url": "http://example.com",
        "following_url": "string",
        "gists_url": "string",
        "gravatar_id": "string",
        "html_url": "http://example.com",
        "id": 0,
        "login": "string",
        "node_id": "string",
        "organizations_url": "http://example.com",
        "received_events_url": "http://example.com",
        "repos_url": "http://example.com",
        "site_admin": true,
        "starred_url": "string",
        "subscriptions_url": "http://example.com",
        "type": "string",
        "url": "http://example.com"
      },
      "permissions": {
        "admin": true,
        "pull": true,
        "push": true
      },
      "private": true,
      "pulls_url": "string",
      "pushed_at": "2019-08-24T14:15:22Z",
      "releases_url": "string",
      "size": 0,
      "ssh_url": "string",
      "stargazers_count": 0,
      "stargazers_url": "http://example.com",
      "statuses_url": "string",
      "subscribers_url": "http://example.com",
      "subscription_url": "http://example.com",
      "svn_url": "http://example.com",
      "tags_url": "http://example.com",
      "teams_url": "http://example.com",
      "temp_clone_token": "string",
      "topics": [
        "string"
      ],
      "trees_url": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "url": "http://example.com",
      "watchers": 0,
      "watchers_count": 0
    },
    "sha": "string",
    "user": {
      "avatar_url": "http://example.com",
      "events_url": "string",
      "followers_url": "http://example.com",
      "following_url": "string",
      "gists_url": "string",
      "gravatar_id": "string",
      "html_url": "http://example.com",
      "id": 0,
      "login": "string",
      "node_id": "string",
      "organizations_url": "http://example.com",
      "received_events_url": "http://example.com",
      "repos_url": "http://example.com",
      "site_admin": true,
      "starred_url": "string",
      "subscriptions_url": "http://example.com",
      "type": "string",
      "url": "http://example.com"
    }
  },
  "body": "Please pull these awesome changes",
  "changed_files": 5,
  "closed_at": "2011-01-26T19:01:12Z",
  "comments": 10,
  "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
  "commits": 3,
  "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits",
  "created_at": "2011-01-26T19:01:12Z",
  "deletions": 3,
  "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
  "draft": false,
  "head": {
    "label": "string",
    "ref": "string",
    "repo": {
      "allow_merge_commit": true,
      "allow_rebase_merge": true,
      "allow_squash_merge": true,
      "archive_url": "string",
      "archived": true,
      "assignees_url": "string",
      "blobs_url": "string",
      "branches_url": "string",
      "clone_url": "string",
      "collaborators_url": "string",
      "comments_url": "string",
      "commits_url": "string",
      "compare_url": "string",
      "contents_url": "string",
      "contributors_url": "http://example.com",
      "created_at": "2019-08-24T14:15:22Z",
      "default_branch": "string",
      "deployments_url": "http://example.com",
      "description": "string",
      "disabled": true,
      "downloads_url": "http://example.com",
      "events_url": "http://example.com",
      "fork": true,
      "forks": 0,
      "forks_count": 0,
      "forks_url": "http://example.com",
      "full_name": "string",
      "git_commits_url": "string",
      "git_refs_url": "string",
      "git_tags_url": "string",
      "git_url": "string",
      "has_downloads": true,
      "has_issues": true,
      "has_pages": true,
      "has_projects": true,
      "has_wiki": true,
      "homepage": "http://example.com",
      "hooks_url": "http://example.com",
      "html_url": "http://example.com",
      "id": 0,
      "issue_comment_url": "string",
      "issue_events_url": "string",
      "issues_url": "string",
      "keys_url": "string",
      "labels_url": "string",
      "language": "string",
      "languages_url": "http://example.com",
      "license": {
        "key": "string",
        "name": "string",
        "node_id": "string",
        "spdx_id": "string",
        "url": "http://example.com"
      },
      "master_branch": "string",
      "merges_url": "http://example.com",
      "milestones_url": "string",
      "mirror_url": "http://example.com",
      "name": "string",
      "node_id": "string",
      "notifications_url": "string",
      "open_issues": 0,
      "open_issues_count": 0,
      "owner": {
        "avatar_url": "http://example.com",
        "events_url": "string",
        "followers_url": "http://example.com",
        "following_url": "string",
        "gists_url": "string",
        "gravatar_id": "string",
        "html_url": "http://example.com",
        "id": 0,
        "login": "string",
        "node_id": "string",
        "organizations_url": "http://example.com",
        "received_events_url": "http://example.com",
        "repos_url": "http://example.com",
        "site_admin": true,
        "starred_url": "string",
        "subscriptions_url": "http://example.com",
        "type": "string",
        "url": "http://example.com"
      },
      "permissions": {
        "admin": true,
        "pull": true,
        "push": true
      },
      "private": true,
      "pulls_url": "string",
      "pushed_at": "2019-08-24T14:15:22Z",
      "releases_url": "string",
      "size": 0,
      "ssh_url": "string",
      "stargazers_count": 0,
      "stargazers_url": "http://example.com",
      "statuses_url": "string",
      "subscribers_url": "http://example.com",
      "subscription_url": "http://example.com",
      "svn_url": "http://example.com",
      "tags_url": "http://example.com",
      "teams_url": "http://example.com",
      "temp_clone_token": "string",
      "topics": [
        "string"
      ],
      "trees_url": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "url": "http://example.com",
      "watchers": 0,
      "watchers_count": 0
    },
    "sha": "string",
    "user": {
      "avatar_url": "http://example.com",
      "events_url": "string",
      "followers_url": "http://example.com",
      "following_url": "string",
      "gists_url": "string",
      "gravatar_id": "string",
      "html_url": "http://example.com",
      "id": 0,
      "login": "string",
      "node_id": "string",
      "organizations_url": "http://example.com",
      "received_events_url": "http://example.com",
      "repos_url": "http://example.com",
      "site_admin": true,
      "starred_url": "string",
      "subscriptions_url": "http://example.com",
      "type": "string",
      "url": "http://example.com"
    }
  },
  "html_url": "https://github.com/octocat/Hello-World/pull/1347",
  "id": 1,
  "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
  "labels": [
    {
      "color": "string",
      "default": true,
      "description": "string",
      "id": 0,
      "name": "string",
      "node_id": "string",
      "url": "string"
    }
  ],
  "locked": true,
  "maintainer_can_modify": true,
  "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6",
  "mergeable": true,
  "mergeable_state": "clean",
  "merged": true,
  "merged_at": "2011-01-26T19:01:12Z",
  "merged_by": {
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
    "html_url": "https://github.com/octocat",
    "id": 1,
    "login": "octocat",
    "node_id": "MDQ6VXNlcjE=",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "site_admin": true,
    "starred_at": "\"2020-07-09T00:17:55Z\"",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "type": "User",
    "url": "https://api.github.com/users/octocat"
  },
  "milestone": {
    "closed_at": "2013-02-12T13:22:01Z",
    "closed_issues": 8,
    "created_at": "2011-04-10T20:09:31Z",
    "creator": {
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
      "html_url": "https://github.com/octocat",
      "id": 1,
      "login": "octocat",
      "node_id": "MDQ6VXNlcjE=",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "site_admin": true,
      "starred_at": "\"2020-07-09T00:17:55Z\"",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "type": "User",
      "url": "https://api.github.com/users/octocat"
    },
    "description": "Tracking milestone for version 1.0",
    "due_on": "2012-10-09T23:39:01Z",
    "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
    "id": 1002604,
    "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
    "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
    "number": 42,
    "open_issues": 4,
    "state": "open",
    "title": "v1.0",
    "updated_at": "2014-03-03T18:58:10Z",
    "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1"
  },
  "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==",
  "number": 42,
  "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch",
  "rebaseable": true,
  "requested_reviewers": [
    {
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
      "html_url": "https://github.com/octocat",
      "id": 1,
      "login": "octocat",
      "node_id": "MDQ6VXNlcjE=",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "site_admin": true,
      "starred_at": "\"2020-07-09T00:17:55Z\"",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "type": "User",
      "url": "https://api.github.com/users/octocat"
    }
  ],
  "requested_teams": [
    {
      "description": "A great team.",
      "html_url": "https://github.com/orgs/rails/teams/core",
      "id": 1,
      "ldap_dn": "uid=example,ou=users,dc=github,dc=com",
      "members_url": "https://api.github.com/organizations/1/team/1/members{/member}",
      "name": "Justice League",
      "node_id": "MDQ6VGVhbTE=",
      "permission": "admin",
      "privacy": "closed",
      "repositories_url": "https://api.github.com/organizations/1/team/1/repos",
      "slug": "justice-league",
      "url": "https://api.github.com/organizations/1/team/1"
    }
  ],
  "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}",
  "review_comments": 0,
  "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments",
  "state": "open",
  "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e",
  "title": "Amazing new feature",
  "updated_at": "2011-01-26T19:01:12Z",
  "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
  "user": {
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
    "html_url": "https://github.com/octocat",
    "id": 1,
    "login": "octocat",
    "node_id": "MDQ6VXNlcjE=",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "site_admin": true,
    "starred_at": "\"2020-07-09T00:17:55Z\"",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "type": "User",
    "url": "https://api.github.com/users/octocat"
  }
}

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Path 参数
owner
string 
必需
repo
string 
必需
Body 参数application/json
base
string 
必需
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
string 
可选
The contents of the pull request.
draft
boolean 
可选
Indicates whether the pull request is a draft. See "Draft Pull Requests" in the GitHub Help documentation to learn more.
head
string 
必需
The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.
issue
integer 
可选
示例值:
1
maintainer_can_modify
boolean 
可选
Indicates whether maintainers can modify the pull request.
title
string 
可选
The title of the new pull request.
示例

返回响应

🟢201Response
application/json
Body
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.
_links
object 
必需
comments
object (Link) 
必需
Hypermedia Link
commits
object (Link) 
必需
Hypermedia Link
html
object (Link) 
必需
Hypermedia Link
issue
object (Link) 
必需
Hypermedia Link
review_comment
object (Link) 
必需
Hypermedia Link
review_comments
object (Link) 
必需
Hypermedia Link
self
object (Link) 
必需
Hypermedia Link
statuses
object (Link) 
必需
Hypermedia Link
active_lock_reason
string  | null 
可选
示例值:
too heated
additions
integer 
必需
示例值:
100
assignee
null 
必需
Simple User
assignees
array[object (Simple User) {19}]  | null 
可选
avatar_url
string <uri>
必需
示例值:
https://github.com/images/error/octocat_happy.gif
events_url
string 
必需
示例值:
https://api.github.com/users/octocat/events{/privacy}
followers_url
string <uri>
必需
示例值:
https://api.github.com/users/octocat/followers
following_url
string 
必需
示例值:
https://api.github.com/users/octocat/following{/other_user}
gists_url
string 
必需
示例值:
https://api.github.com/users/octocat/gists{/gist_id}
gravatar_id
string  | null 
必需
示例值:
41d064eb2195891e12d0413f63227ea7
html_url
string <uri>
必需
示例值:
https://github.com/octocat
id
integer 
必需
示例值:
1
login
string 
必需
示例值:
octocat
node_id
string 
必需
示例值:
MDQ6VXNlcjE=
organizations_url
string <uri>
必需
示例值:
https://api.github.com/users/octocat/orgs
received_events_url
string <uri>
必需
示例值:
https://api.github.com/users/octocat/received_events
repos_url
string <uri>
必需
示例值:
https://api.github.com/users/octocat/repos
site_admin
boolean 
必需
starred_at
string 
可选
示例值:
"2020-07-09T00:17:55Z"
starred_url
string 
必需
示例值:
https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url
string <uri>
必需
示例值:
https://api.github.com/users/octocat/subscriptions
type
string 
必需
示例值:
User
url
string <uri>
必需
示例值:
https://api.github.com/users/octocat
author_association
enum<string> 
必需
How the author is associated with the repository.
枚举值:
COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER
示例值:
OWNER
base
object 
必需
label
string 
必需
ref
string 
必需
repo
object 
必需
sha
string 
必需
user
object 
必需
body
string  | null 
必需
示例值:
Please pull these awesome changes
changed_files
integer 
必需
示例值:
5
closed_at
string <date-time> | null 
必需
示例值:
2011-01-26T19:01:12Z
comments
integer 
必需
示例值:
10
comments_url
string <uri>
必需
示例值:
https://api.github.com/repos/octocat/Hello-World/issues/1347/comments
commits
integer 
必需
示例值:
3
commits_url
string <uri>
必需
示例值:
https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits
created_at
string <date-time>
必需
示例值:
2011-01-26T19:01:12Z
deletions
integer 
必需
示例值:
3
diff_url
string <uri>
必需
示例值:
https://github.com/octocat/Hello-World/pull/1347.diff
draft
boolean 
可选
Indicates whether or not the pull request is a draft.
示例值:
false
head
object 
必需
label
string 
必需
ref
string 
必需
repo
object 
必需
sha
string 
必需
user
object 
必需
html_url
string <uri>
必需
示例值:
https://github.com/octocat/Hello-World/pull/1347
id
integer 
必需
示例值:
1
issue_url
string <uri>
必需
示例值:
https://api.github.com/repos/octocat/Hello-World/issues/1347
labels
array [object {7}] 
必需
color
string 
可选
default
boolean 
可选
description
string  | null 
可选
id
integer <int64>
可选
name
string 
可选
node_id
string 
可选
url
string 
可选
locked
boolean 
必需
示例值:
true
maintainer_can_modify
boolean 
必需
Indicates whether maintainers can modify the pull request.
示例值:
true
merge_commit_sha
string  | null 
必需
示例值:
e5bd3914e2e596debea16f433f57875b5b90bcd6
mergeable
boolean  | null 
必需
示例值:
true
mergeable_state
string 
必需
示例值:
clean
merged
boolean 
必需
merged_at
string <date-time> | null 
必需
示例值:
2011-01-26T19:01:12Z
merged_by
null 
必需
Simple User
milestone
null  | allOf {1} 
必需
object (Milestone) 
可选
A collection of related issues and pull requests.
node_id
string 
必需
示例值:
MDExOlB1bGxSZXF1ZXN0MQ==
number
integer 
必需
Number uniquely identifying the pull request within its repository.
示例值:
42
patch_url
string <uri>
必需
示例值:
https://github.com/octocat/Hello-World/pull/1347.patch
rebaseable
boolean  | null 
可选
示例值:
true
requested_reviewers
array[object (Simple User) {19}]  | null 
可选
avatar_url
string <uri>
必需
示例值:
https://github.com/images/error/octocat_happy.gif
events_url
string 
必需
示例值:
https://api.github.com/users/octocat/events{/privacy}
followers_url
string <uri>
必需
示例值:
https://api.github.com/users/octocat/followers
following_url
string 
必需
示例值:
https://api.github.com/users/octocat/following{/other_user}
gists_url
string 
必需
示例值:
https://api.github.com/users/octocat/gists{/gist_id}
gravatar_id
string  | null 
必需
示例值:
41d064eb2195891e12d0413f63227ea7
html_url
string <uri>
必需
示例值:
https://github.com/octocat
id
integer 
必需
示例值:
1
login
string 
必需
示例值:
octocat
node_id
string 
必需
示例值:
MDQ6VXNlcjE=
organizations_url
string <uri>
必需
示例值:
https://api.github.com/users/octocat/orgs
received_events_url
string <uri>
必需
示例值:
https://api.github.com/users/octocat/received_events
repos_url
string <uri>
必需
示例值:
https://api.github.com/users/octocat/repos
site_admin
boolean 
必需
starred_at
string 
可选
示例值:
"2020-07-09T00:17:55Z"
starred_url
string 
必需
示例值:
https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url
string <uri>
必需
示例值:
https://api.github.com/users/octocat/subscriptions
type
string 
必需
示例值:
User
url
string <uri>
必需
示例值:
https://api.github.com/users/octocat
requested_teams
array[object (Team Simple) {12}]  | null 
可选
description
string  | null 
必需
Description of the team
示例值:
A great team.
html_url
string <uri>
必需
示例值:
https://github.com/orgs/rails/teams/core
id
integer 
必需
Unique identifier of the team
示例值:
1
ldap_dn
string 
可选
Distinguished Name (DN) that team maps to within LDAP environment
示例值:
uid=example,ou=users,dc=github,dc=com
members_url
string 
必需
示例值:
https://api.github.com/organizations/1/team/1/members{/member}
name
string 
必需
Name of the team
示例值:
Justice League
node_id
string 
必需
示例值:
MDQ6VGVhbTE=
permission
string 
必需
Permission that the team will have for its repositories
示例值:
admin
privacy
string 
可选
The level of privacy this team should have
示例值:
closed
repositories_url
string <uri>
必需
示例值:
https://api.github.com/organizations/1/team/1/repos
slug
string 
必需
示例值:
justice-league
url
string <uri>
必需
URL for the team
示例值:
https://api.github.com/organizations/1/team/1
review_comment_url
string 
必需
示例值:
https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}
review_comments
integer 
必需
示例值:
0
review_comments_url
string <uri>
必需
示例值:
https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments
state
enum<string> 
必需
State of this Pull Request. Either open or closed.
枚举值:
openclosed
示例值:
open
statuses_url
string <uri>
必需
示例值:
https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e
title
string 
必需
The title of the pull request.
示例值:
Amazing new feature
updated_at
string <date-time>
必需
示例值:
2011-01-26T19:01:12Z
url
string <uri>
必需
示例值:
https://api.github.com/repos/octocat/Hello-World/pulls/1347
user
null 
必需
Simple User
🟠403403
🟠422422

【GitHub】API开发者 微信交流群

用微信扫右侧二维码,加入【GitHub】API开发者 交流群,互助沟通

扫码加入交流群
上一页
List pull requests
下一页
List review comments in a repository
Built with