GitHub GraphQL API
Why is GitHub using GraphQL?
GitHub is moving to GraphQL for v4 of our API because it offers significantly more flexibility for our integrators. The ability to define precisely the data you want—and only the data you want—is a powerful advantage over the REST API v3 endpoints.
GraphQL is a new way to think about building and querying APIs. Rather than construct several REST requests to fetch data that you're interested in, you can often make a single call to fetch the information you need.
For reference information autogenerated from GitHub's GraphQL schema, explore the links in the sidebar.
For information about how to use GitHub's GraphQL API v4, explore our guides.
Overview
Query
-
Mutations
- acceptTopicSuggestion
- addComment
- addProjectCard
- addProjectColumn
- addPullRequestReview
- addPullRequestReviewComment
- addReaction
- addStar
- createProject
- declineTopicSuggestion
- deleteProject
- deleteProjectCard
- deleteProjectColumn
- deletePullRequestReview
- dismissPullRequestReview
- moveProjectCard
- moveProjectColumn
- removeOutsideCollaborator
- removeReaction
- removeStar
- requestReviews
- submitPullRequestReview
- updateProject
- updateProjectCard
- updateProjectColumn
- updatePullRequestReview
- updatePullRequestReviewComment
- updateSubscription
- updateTopics
-
Objects
- AssignedEvent
- BaseRefForcePushedEvent
- Blame
- BlameRange
- Blob
- Bot
- ClosedEvent
- CodeOfConduct
- Commit
- CommitComment
- DemilestonedEvent
- DeployedEvent
- Deployment
- DeploymentStatus
- ExternalIdentity
- ExternalIdentitySamlAttributes
- ExternalIdentityScimAttributes
- Gist
- GistComment
- GitActor
- GpgSignature
- HeadRefDeletedEvent
- HeadRefForcePushedEvent
- HeadRefRestoredEvent
- Integration
- Issue
- IssueComment
- Label
- LabeledEvent
- Language
- LockedEvent
- MergedEvent
- Milestone
- MilestonedEvent
- Organization
- OrganizationIdentityProvider
- OrganizationInvitation
- PageInfo
- Project
- ProjectCard
- ProjectColumn
- ProtectedBranch
- PullRequest
- PullRequestCommit
- PullRequestReview
- PullRequestReviewComment
- PullRequestReviewThread
- PushAllowance
- RateLimit
- Reaction
- ReactionGroup
- Ref
- ReferencedEvent
- Release
- ReleaseAsset
- RenamedTitleEvent
- ReopenedEvent
- Repository
- RepositoryInvitation
- RepositoryInvitationRepository
- RepositoryTopic
- ReviewDismissalAllowance
- ReviewDismissedEvent
- ReviewRequest
- ReviewRequestRemovedEvent
- ReviewRequestedEvent
- SmimeSignature
- Status
- StatusContext
- SubscribedEvent
- SuggestedReviewer
- Tag
- Team
- Topic
- Tree
- TreeEntry
- UnassignedEvent
- UnknownSignature
- UnlabeledEvent
- UnlockedEvent
- UnsubscribedEvent
- User
-
Interfaces
-
Enums
- CommentCannotUpdateReason
- DefaultRepositoryPermissionField
- DeploymentState
- DeploymentStatusState
- GistPrivacy
- GitSignatureState
- IssueOrderField
- IssuePubSubTopic
- IssueState
- LanguageOrderField
- MergeableState
- MilestoneState
- OrderDirection
- OrganizationInvitationRole
- ProjectCardState
- ProjectOrderField
- ProjectState
- PullRequestPubSubTopic
- PullRequestReviewEvent
- PullRequestReviewState
- PullRequestState
- ReactionContent
- ReactionOrderField
- RepositoryAffiliation
- RepositoryCollaboratorAffiliation
- RepositoryLockReason
- RepositoryOrderField
- RepositoryPrivacy
- SearchType
- StarOrderField
- StatusState
- SubscriptionState
- TeamOrderField
- TeamPrivacy
- TeamRole
- TopicSuggestionDeclineReason
- UserOrderField
-
Unions
-
Input Objects
-
Scalars