How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

GitHub Pull API

The Pull API from GitHub — 19 operation(s) for pull.

GitHub Pull API is one of 350 APIs that GitHub publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Pull. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and an API reference.

This API exposes 32 operations across 18 paths, and defines 30 schemas. It is described by OpenAPI 3.2.0, at version 1.1.4.

Requests are made against a single base URL, {protocol}://{hostname}.

32 operations 18 paths 30 schemas 5 DELETE14 GET3 PATCH6 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.1.4
Base URL
https://api.github.com
Authentication
HTTP Bearer
Contact
License
Terms of Service
Resource Areas
1

Authentication & Security 1

GitHub Pull API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerHttpAuthentication).

  • bearerHttpAuthentication — Bearer Token

Paths & Operations 32

Across 18 paths, the API surfaces 32 operations — 5 DELETE, 14 GET, 3 PATCH, 6 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Pull 32
GET
/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews
GitHub Get Pull Request Review Protection
getPullRequestReviewProtection 6 params → 200
PATCH
/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews
GitHub Update Pull Request Review Protection
updatePullRequestReviewProtection 6 params body → 200422
DELETE
/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews
GitHub Delete Pull Request Review Protection
deletePullRequestReviewProtection 6 params → 204404
GET
/repos/{owner}/{repo}/pulls
GitHub List Pull Requests
listPullRequests 12 params → 200304422
POST
/repos/{owner}/{repo}/pulls
GitHub Create Pull Request
createPullRequest 5 params body → 201403422
GET
/repos/{owner}/{repo}/pulls/comments/{comment_id}
GitHub Get Review Comment for Pull Request
getReviewCommentForPullRequest 6 params → 200404
PATCH
/repos/{owner}/{repo}/pulls/comments/{comment_id}
GitHub Update Review Comment for Pull Request
updateReviewCommentForPullRequest 6 params body → 200
DELETE
/repos/{owner}/{repo}/pulls/comments/{comment_id}
GitHub Delete Review Comment for Pull Request
deleteReviewCommentForPullRequest 6 params → 204404
GET
/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions
GitHub List Reactions for Pull Request Review Comment
listReactionsForPullRequestReviewComment 9 params → 200404
POST
/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions
GitHub Create Reaction for Pull Request Review Comment
createReactionForPullRequestReviewComment 6 params body → 200201422
DELETE
/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}
GitHub Delete Pull Request Comment Reaction
deletePullRequestCommentReaction 7 params → 204
GET
/repos/{owner}/{repo}/pulls/{pull_number}
GitHub Get Pull Request
getPullRequest 6 params → 200304404500503
PATCH
/repos/{owner}/{repo}/pulls/{pull_number}
GitHub Update Pull Request
updatePullRequest 6 params body → 200403422
GET
/repos/{owner}/{repo}/pulls/{pull_number}/comments
GitHub List Review Comments on Pull Request
listReviewCommentsOnPullRequest 11 params → 200
POST
/repos/{owner}/{repo}/pulls/{pull_number}/comments
GitHub Create Review Comment for Pull Request
createReviewCommentForPullRequest 6 params body → 201403422
GET
/repos/{owner}/{repo}/pulls/{pull_number}/commits
GitHub List Commits on Pull Request
listCommitsOnPullRequest 8 params → 200
GET
/repos/{owner}/{repo}/pulls/{pull_number}/files
GitHub List Pull Requests Files
listPullRequestsFiles 8 params → 200422500503
GET
/repos/{owner}/{repo}/pulls/{pull_number}/merge
GitHub Check if Pull Request Has Been Merged
checkIfPullRequestHasBeenMerged 6 params → 204404
PUT
/repos/{owner}/{repo}/pulls/{pull_number}/merge
GitHub Merge Pull Request
mergePullRequest 6 params body → 200403404405409422
GET
/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers
GitHub Get All Requested Reviewers for Pull Request
getAllRequestedReviewersForPullRequest 6 params → 200
POST
/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers
GitHub Request Reviewers for Pull Request
requestReviewersForPullRequest 6 params body → 201403422
DELETE
/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers
GitHub Remove Requested Reviewers from Pull Request
removeRequestedReviewersFromPullRequest 6 params body → 200422
GET
/repos/{owner}/{repo}/pulls/{pull_number}/reviews
GitHub List Reviews for Pull Request
listReviewsForPullRequest 8 params → 200
POST
/repos/{owner}/{repo}/pulls/{pull_number}/reviews
GitHub Create Review for Pull Request
createReviewForPullRequest 6 params body → 200403422
GET
/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}
GitHub Get Review for Pull Request
getReviewForPullRequest 7 params → 200404
PUT
/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}
GitHub Update Review for Pull Request
updateReviewForPullRequest 7 params body → 200422
DELETE
/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}
GitHub Delete Pending Review for Pull Request
deletePendingReviewForPullRequest 7 params → 200404422
GET
/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments
GitHub List Comments for Pull Request Review
listCommentsForPullRequestReview 9 params → 200404
PUT
/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals
GitHub Dismiss Review for Pull Request
dismissReviewForPullRequest 7 params body → 200404422
POST
/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events
GitHub Submit Review for Pull Request
submitReviewForPullRequest 7 params body → 200403404422
PUT
/repos/{owner}/{repo}/pulls/{pull_number}/update-branch
GitHub Update Pull Request Branch
updatePullRequestBranch 6 params body → 202403422
GET
/repos/{owner}/{repo}/commits/{commit_sha}/pulls
GitHub List Pull Requests Associated with Commit
listPullRequestsAssociatedWithCommit 8 params → 200

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are repository (95 properties), pull-request (48 properties), pull-request-simple (36 properties), pull-request-review-comment (29 properties). Each schema is shown below with its type and property counts.

integration
object
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They…
17 properties 11 required
simple-user
object
GitHub user.
21 properties 18 required
nullable-simple-user
object
GitHub user.
21 properties 18 required
protected-branch-pull-request-review
object
Protected Branch Pull Request Review
7 properties 2 required
validation-error
object
Validation Error
3 properties 2 required
basic-error
object
Basic Error
4 properties
team
object
Groups of organization members that gives permissions on specified repositories.
13 properties 11 required
nullable-team-simple
object
Groups of organization members that gives permissions on specified repositories.
12 properties 10 required
pull-request-review-request
object
Pull Request Review Request
2 properties 2 required
validation-error-simple
object
Validation Error Simple
3 properties 2 required
link
object
Hypermedia Link
1 property 1 required
pull-request
object
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…
48 properties 42 required
diff-entry
object
Diff Entry
11 properties 9 required
commit
object
Commit
11 properties 9 required
nullable-git-user
object
Metaproperties for Git author/committer information.
3 properties
repository
object
repository on GitHub.
95 properties 73 required
pull-request-review
object
Pull Request Reviews are reviews on pull requests.
13 properties 10 required
verification
object
4 properties 4 required
team-simple
object
Groups of organization members that gives permissions on specified repositories.
12 properties 10 required
pull-request-simple
object
Pull Request Simple
36 properties 31 required
reaction-rollup
object
10 properties 10 required
pull-request-merge-result
object
Pull Request Merge Result
3 properties 3 required
empty-object
object
An object without any properties.
review-comment
object
Legacy Review Comment
28 properties 18 required
auto-merge
object
The status of auto merging a pull request.
4 properties 4 required
pull-request-review-comment
object
Pull Request Review Comments are comments on a portion of the Pull Request's diff.
29 properties 16 required
reaction
object
Reactions to conversations provide a way to help people express their feelings more simply and effectively.
5 properties 5 required
author-association
string
How the author is associated with the repository.
nullable-milestone
object
collection of related issues and pull requests.
16 properties 16 required
nullable-license-simple
object
License Simple
6 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

github-pull-api-openapi.yml Raw ↑

Other APIs GitHub publishes across the network.

GitHub Events API
GitHub Feeds API
GitHub Gists API
GitHub Issues API
GitHub Licenses API
GitHub Markdown API
GitHub Meta API
GitHub Notifications API
GitHub Octocat API
GitHub Projects API
GitHub Repos API
GitHub Search API
Where this information came from

This is an independent, third-party profile of GitHub Pull API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.