API Docs
GraphQL API v4
REST API v3
Apps
Webhooks
Blog
Forum
Versions
GitHub.com
Enterprise 2.14
Enterprise 2.13
Enterprise 2.12
GraphQL API v4
Reference
Guides
Explorer
Changelog
Navigate the docs…
Overview
What is GraphQL?
Why is GitHub using GraphQL?
About the GraphQL schema reference
Schema Previews
Breaking Changes
Guides overview
Intro to GraphQL
Migrating from REST
Using the Explorer
Forming Calls
Resource Limitations
Reference overview
Query overview
Connections
Fields
Mutations overview
acceptTopicSuggestion
addAssigneesToAssignable
addComment
addLabelsToLabelable
addProjectCard
addProjectColumn
addPullRequestReview
addPullRequestReviewComment
addReaction
addStar
clearLabelsFromLabelable
closeIssue
convertProjectCardNoteToIssue
createBranchProtectionRule
createCheckRun
createCheckSuite
createDeployment
createDeploymentStatus
createIssue
createProject
createTeamDiscussion
createTeamDiscussionComment
declineTopicSuggestion
deleteBranchProtectionRule
deleteIssueComment
deleteProject
deleteProjectCard
deleteProjectColumn
deletePullRequestReview
deleteTeamDiscussion
deleteTeamDiscussionComment
dismissPullRequestReview
lockLockable
moveProjectCard
moveProjectColumn
removeAssigneesFromAssignable
removeLabelsFromLabelable
removeOutsideCollaborator
removeReaction
removeStar
reopenIssue
requestReviews
rerequestCheckSuite
resolveReviewThread
submitPullRequestReview
unlockLockable
unmarkIssueAsDuplicate
unresolveReviewThread
updateBranchProtectionRule
updateCheckRun
updateCheckSuitePreferences
updateIssue
updateIssueComment
updateProject
updateProjectCard
updateProjectColumn
updatePullRequestReview
updatePullRequestReviewComment
updateSubscription
updateTeamDiscussion
updateTeamDiscussionComment
updateTopics
Scalars overview
Boolean
DateTime
Float
GitObjectID
GitSSHRemote
GitTimestamp
HTML
ID
Int
String
URI
X509Certificate
Objects overview
AddedToProjectEvent
App
AssignedEvent
BaseRefChangedEvent
BaseRefForcePushedEvent
Blame
BlameRange
Blob
Bot
BranchProtectionRule
BranchProtectionRuleConflict
CheckAnnotation
CheckAnnotationPosition
CheckAnnotationSpan
CheckRun
CheckSuite
ClosedEvent
CodeOfConduct
CommentDeletedEvent
Commit
CommitComment
CommitCommentThread
ConvertedNoteToIssueEvent
CrossReferencedEvent
DemilestonedEvent
DependencyGraphDependency
DependencyGraphManifest
DeployKey
DeployedEvent
Deployment
DeploymentEnvironmentChangedEvent
DeploymentStatus
ExternalIdentity
ExternalIdentitySamlAttributes
ExternalIdentityScimAttributes
GenericHovercardContext
Gist
GistComment
GitActor
GitHubMetadata
GpgSignature
HeadRefDeletedEvent
HeadRefForcePushedEvent
HeadRefRestoredEvent
Hovercard
Issue
IssueComment
Label
LabeledEvent
Language
License
LicenseRule
LockedEvent
MarketplaceCategory
MarketplaceListing
MentionedEvent
MergedEvent
Milestone
MilestonedEvent
MovedColumnsInProjectEvent
Organization
OrganizationIdentityProvider
OrganizationInvitation
OrganizationTeamsHovercardContext
OrganizationsHovercardContext
PageInfo
Project
ProjectCard
ProjectColumn
ProtectedBranch
PublicKey
PullRequest
PullRequestCommit
PullRequestCommitCommentThread
PullRequestReview
PullRequestReviewComment
PullRequestReviewThread
PullRequestRevisionMarker
Push
PushAllowance
RateLimit
Reaction
ReactionGroup
Ref
ReferencedEvent
Release
ReleaseAsset
RemovedFromProjectEvent
RenamedTitleEvent
ReopenedEvent
Repository
RepositoryInvitation
RepositoryTopic
RepositoryVulnerabilityAlert
ReviewDismissalAllowance
ReviewDismissedEvent
ReviewRequest
ReviewRequestRemovedEvent
ReviewRequestedEvent
SmimeSignature
Status
StatusContext
SubscribedEvent
SuggestedReviewer
Tag
Team
TeamDiscussion
TeamDiscussionComment
TextMatch
TextMatchHighlight
Topic
Tree
TreeEntry
UnassignedEvent
UnknownSignature
UnlabeledEvent
UnlockedEvent
UnsubscribedEvent
User
UserContentEdit
Interfaces overview
Actor
Assignable
Closable
Comment
Deletable
GitObject
GitSignature
HovercardContext
Labelable
Lockable
Node
ProjectOwner
Reactable
RegistryPackageOwner
RegistryPackageSearch
RepositoryInfo
RepositoryNode
RepositoryOwner
Starrable
Subscribable
UniformResourceLocatable
Updatable
UpdatableComment
Enums overview
CheckAnnotationLevel
CheckConclusionState
CheckRunType
CheckStatusState
CollaboratorAffiliation
CommentAuthorAssociation
CommentCannotUpdateReason
DeploymentState
DeploymentStatusState
GistOrderField
GistPrivacy
GitSignatureState
IssueOrderField
IssueState
IssueTimelineItemsItemType
LanguageOrderField
LockReason
MergeStateStatus
MergeableState
MilestoneOrderField
MilestoneState
OrderDirection
OrganizationInvitationRole
OrganizationInvitationType
ProjectCardArchivedState
ProjectCardState
ProjectColumnPurpose
ProjectOrderField
ProjectState
PullRequestOrderField
PullRequestReviewCommentState
PullRequestReviewEvent
PullRequestReviewState
PullRequestState
PullRequestTimelineItemsItemType
ReactionContent
ReactionOrderField
RefOrderField
ReleaseOrderField
RepositoryAffiliation
RepositoryContributionType
RepositoryLockReason
RepositoryOrderField
RepositoryPermission
RepositoryPrivacy
RequestableCheckStatusState
SearchType
StarOrderField
StatusState
SubscriptionState
TeamDiscussionCommentOrderField
TeamDiscussionOrderField
TeamMemberOrderField
TeamMemberRole
TeamMembershipType
TeamOrderField
TeamPrivacy
TeamRepositoryOrderField
TeamRole
TopicSuggestionDeclineReason
Unions overview
Closer
CollectionItemContent
IssueOrPullRequest
IssueTimelineItem
IssueTimelineItems
MilestoneItem
ProjectCardItem
PullRequestTimelineItem
PullRequestTimelineItems
PushAllowanceActor
ReferencedSubject
RenamedTitleSubject
RequestedReviewer
ReviewDismissalAllowanceActor
SearchResultItem
Input Objects overview
CheckAnnotationData
CheckAnnotationRange
CheckRunAction
CheckRunFilter
CheckRunOutput
CheckRunOutputImage
CheckSuiteAutoTriggerPreference
CheckSuiteFilter
CommitAuthor
DraftPullRequestReviewComment
GistOrder
IssueFilters
IssueOrder
LanguageOrder
MilestoneOrder
ProjectOrder
ReactionOrder
RefOrder
ReleaseOrder
RepositoryOrder
StarOrder
TeamDiscussionCommentOrder
TeamDiscussionOrder
TeamMemberOrder
TeamOrder
TeamRepositoryOrder
GitSSHRemote
Git SSH string
Navigate the docs…
Overview
What is GraphQL?
Why is GitHub using GraphQL?
About the GraphQL schema reference
Schema Previews
Breaking Changes
Guides overview
Intro to GraphQL
Migrating from REST
Using the Explorer
Forming Calls
Resource Limitations
Reference overview
Query overview
Connections
Fields
Mutations overview
acceptTopicSuggestion
addAssigneesToAssignable
addComment
addLabelsToLabelable
addProjectCard
addProjectColumn
addPullRequestReview
addPullRequestReviewComment
addReaction
addStar
clearLabelsFromLabelable
closeIssue
convertProjectCardNoteToIssue
createBranchProtectionRule
createCheckRun
createCheckSuite
createDeployment
createDeploymentStatus
createIssue
createProject
createTeamDiscussion
createTeamDiscussionComment
declineTopicSuggestion
deleteBranchProtectionRule
deleteIssueComment
deleteProject
deleteProjectCard
deleteProjectColumn
deletePullRequestReview
deleteTeamDiscussion
deleteTeamDiscussionComment
dismissPullRequestReview
lockLockable
moveProjectCard
moveProjectColumn
removeAssigneesFromAssignable
removeLabelsFromLabelable
removeOutsideCollaborator
removeReaction
removeStar
reopenIssue
requestReviews
rerequestCheckSuite
resolveReviewThread
submitPullRequestReview
unlockLockable
unmarkIssueAsDuplicate
unresolveReviewThread
updateBranchProtectionRule
updateCheckRun
updateCheckSuitePreferences
updateIssue
updateIssueComment
updateProject
updateProjectCard
updateProjectColumn
updatePullRequestReview
updatePullRequestReviewComment
updateSubscription
updateTeamDiscussion
updateTeamDiscussionComment
updateTopics
Scalars overview
Boolean
DateTime
Float
GitObjectID
GitSSHRemote
GitTimestamp
HTML
ID
Int
String
URI
X509Certificate
Objects overview
AddedToProjectEvent
App
AssignedEvent
BaseRefChangedEvent
BaseRefForcePushedEvent
Blame
BlameRange
Blob
Bot
BranchProtectionRule
BranchProtectionRuleConflict
CheckAnnotation
CheckAnnotationPosition
CheckAnnotationSpan
CheckRun
CheckSuite
ClosedEvent
CodeOfConduct
CommentDeletedEvent
Commit
CommitComment
CommitCommentThread
ConvertedNoteToIssueEvent
CrossReferencedEvent
DemilestonedEvent
DependencyGraphDependency
DependencyGraphManifest
DeployKey
DeployedEvent
Deployment
DeploymentEnvironmentChangedEvent
DeploymentStatus
ExternalIdentity
ExternalIdentitySamlAttributes
ExternalIdentityScimAttributes
GenericHovercardContext
Gist
GistComment
GitActor
GitHubMetadata
GpgSignature
HeadRefDeletedEvent
HeadRefForcePushedEvent
HeadRefRestoredEvent
Hovercard
Issue
IssueComment
Label
LabeledEvent
Language
License
LicenseRule
LockedEvent
MarketplaceCategory
MarketplaceListing
MentionedEvent
MergedEvent
Milestone
MilestonedEvent
MovedColumnsInProjectEvent
Organization
OrganizationIdentityProvider
OrganizationInvitation
OrganizationTeamsHovercardContext
OrganizationsHovercardContext
PageInfo
Project
ProjectCard
ProjectColumn
ProtectedBranch
PublicKey
PullRequest
PullRequestCommit
PullRequestCommitCommentThread
PullRequestReview
PullRequestReviewComment
PullRequestReviewThread
PullRequestRevisionMarker
Push
PushAllowance
RateLimit
Reaction
ReactionGroup
Ref
ReferencedEvent
Release
ReleaseAsset
RemovedFromProjectEvent
RenamedTitleEvent
ReopenedEvent
Repository
RepositoryInvitation
RepositoryTopic
RepositoryVulnerabilityAlert
ReviewDismissalAllowance
ReviewDismissedEvent
ReviewRequest
ReviewRequestRemovedEvent
ReviewRequestedEvent
SmimeSignature
Status
StatusContext
SubscribedEvent
SuggestedReviewer
Tag
Team
TeamDiscussion
TeamDiscussionComment
TextMatch
TextMatchHighlight
Topic
Tree
TreeEntry
UnassignedEvent
UnknownSignature
UnlabeledEvent
UnlockedEvent
UnsubscribedEvent
User
UserContentEdit
Interfaces overview
Actor
Assignable
Closable
Comment
Deletable
GitObject
GitSignature
HovercardContext
Labelable
Lockable
Node
ProjectOwner
Reactable
RegistryPackageOwner
RegistryPackageSearch
RepositoryInfo
RepositoryNode
RepositoryOwner
Starrable
Subscribable
UniformResourceLocatable
Updatable
UpdatableComment
Enums overview
CheckAnnotationLevel
CheckConclusionState
CheckRunType
CheckStatusState
CollaboratorAffiliation
CommentAuthorAssociation
CommentCannotUpdateReason
DeploymentState
DeploymentStatusState
GistOrderField
GistPrivacy
GitSignatureState
IssueOrderField
IssueState
IssueTimelineItemsItemType
LanguageOrderField
LockReason
MergeStateStatus
MergeableState
MilestoneOrderField
MilestoneState
OrderDirection
OrganizationInvitationRole
OrganizationInvitationType
ProjectCardArchivedState
ProjectCardState
ProjectColumnPurpose
ProjectOrderField
ProjectState
PullRequestOrderField
PullRequestReviewCommentState
PullRequestReviewEvent
PullRequestReviewState
PullRequestState
PullRequestTimelineItemsItemType
ReactionContent
ReactionOrderField
RefOrderField
ReleaseOrderField
RepositoryAffiliation
RepositoryContributionType
RepositoryLockReason
RepositoryOrderField
RepositoryPermission
RepositoryPrivacy
RequestableCheckStatusState
SearchType
StarOrderField
StatusState
SubscriptionState
TeamDiscussionCommentOrderField
TeamDiscussionOrderField
TeamMemberOrderField
TeamMemberRole
TeamMembershipType
TeamOrderField
TeamPrivacy
TeamRepositoryOrderField
TeamRole
TopicSuggestionDeclineReason
Unions overview
Closer
CollectionItemContent
IssueOrPullRequest
IssueTimelineItem
IssueTimelineItems
MilestoneItem
ProjectCardItem
PullRequestTimelineItem
PullRequestTimelineItems
PushAllowanceActor
ReferencedSubject
RenamedTitleSubject
RequestedReviewer
ReviewDismissalAllowanceActor
SearchResultItem
Input Objects overview
CheckAnnotationData
CheckAnnotationRange
CheckRunAction
CheckRunFilter
CheckRunOutput
CheckRunOutputImage
CheckSuiteAutoTriggerPreference
CheckSuiteFilter
CommitAuthor
DraftPullRequestReviewComment
GistOrder
IssueFilters
IssueOrder
LanguageOrder
MilestoneOrder
ProjectOrder
ReactionOrder
RefOrder
ReleaseOrder
RepositoryOrder
StarOrder
TeamDiscussionCommentOrder
TeamDiscussionOrder
TeamMemberOrder
TeamOrder
TeamRepositoryOrder
Overview
What is GraphQL?
Why is GitHub using GraphQL?
About the GraphQL schema reference
Schema Previews
Breaking Changes
Query
Connections
Fields
Mutations
acceptTopicSuggestion
addAssigneesToAssignable
addComment
addLabelsToLabelable
addProjectCard
addProjectColumn
addPullRequestReview
addPullRequestReviewComment
addReaction
addStar
clearLabelsFromLabelable
closeIssue
convertProjectCardNoteToIssue
createBranchProtectionRule
createCheckRun
createCheckSuite
createDeployment
createDeploymentStatus
createIssue
createProject
createTeamDiscussion
createTeamDiscussionComment
declineTopicSuggestion
deleteBranchProtectionRule
deleteIssueComment
deleteProject
deleteProjectCard
deleteProjectColumn
deletePullRequestReview
deleteTeamDiscussion
deleteTeamDiscussionComment
dismissPullRequestReview
lockLockable
moveProjectCard
moveProjectColumn
removeAssigneesFromAssignable
removeLabelsFromLabelable
removeOutsideCollaborator
removeReaction
removeStar
reopenIssue
requestReviews
rerequestCheckSuite
resolveReviewThread
submitPullRequestReview
unlockLockable
unmarkIssueAsDuplicate
unresolveReviewThread
updateBranchProtectionRule
updateCheckRun
updateCheckSuitePreferences
updateIssue
updateIssueComment
updateProject
updateProjectCard
updateProjectColumn
updatePullRequestReview
updatePullRequestReviewComment
updateSubscription
updateTeamDiscussion
updateTeamDiscussionComment
updateTopics
Objects
AddedToProjectEvent
App
AssignedEvent
BaseRefChangedEvent
BaseRefForcePushedEvent
Blame
BlameRange
Blob
Bot
BranchProtectionRule
BranchProtectionRuleConflict
CheckAnnotation
CheckAnnotationPosition
CheckAnnotationSpan
CheckRun
CheckSuite
ClosedEvent
CodeOfConduct
CommentDeletedEvent
Commit
CommitComment
CommitCommentThread
ConvertedNoteToIssueEvent
CrossReferencedEvent
DemilestonedEvent
DependencyGraphDependency
DependencyGraphManifest
DeployKey
DeployedEvent
Deployment
DeploymentEnvironmentChangedEvent
DeploymentStatus
ExternalIdentity
ExternalIdentitySamlAttributes
ExternalIdentityScimAttributes
GenericHovercardContext
Gist
GistComment
GitActor
GitHubMetadata
GpgSignature
HeadRefDeletedEvent
HeadRefForcePushedEvent
HeadRefRestoredEvent
Hovercard
Issue
IssueComment
Label
LabeledEvent
Language
License
LicenseRule
LockedEvent
MarketplaceCategory
MarketplaceListing
MentionedEvent
MergedEvent
Milestone
MilestonedEvent
MovedColumnsInProjectEvent
Organization
OrganizationIdentityProvider
OrganizationInvitation
OrganizationTeamsHovercardContext
OrganizationsHovercardContext
PageInfo
Project
ProjectCard
ProjectColumn
ProtectedBranch
PublicKey
PullRequest
PullRequestCommit
PullRequestCommitCommentThread
PullRequestReview
PullRequestReviewComment
PullRequestReviewThread
PullRequestRevisionMarker
Push
PushAllowance
RateLimit
Reaction
ReactionGroup
Ref
ReferencedEvent
Release
ReleaseAsset
RemovedFromProjectEvent
RenamedTitleEvent
ReopenedEvent
Repository
RepositoryInvitation
RepositoryTopic
RepositoryVulnerabilityAlert
ReviewDismissalAllowance
ReviewDismissedEvent
ReviewRequest
ReviewRequestRemovedEvent
ReviewRequestedEvent
SmimeSignature
Status
StatusContext
SubscribedEvent
SuggestedReviewer
Tag
Team
TeamDiscussion
TeamDiscussionComment
TextMatch
TextMatchHighlight
Topic
Tree
TreeEntry
UnassignedEvent
UnknownSignature
UnlabeledEvent
UnlockedEvent
UnsubscribedEvent
User
UserContentEdit
Interfaces
Actor
Assignable
Closable
Comment
Deletable
GitObject
GitSignature
HovercardContext
Labelable
Lockable
Node
ProjectOwner
Reactable
RegistryPackageOwner
RegistryPackageSearch
RepositoryInfo
RepositoryNode
RepositoryOwner
Starrable
Subscribable
UniformResourceLocatable
Updatable
UpdatableComment
Enums
CheckAnnotationLevel
CheckConclusionState
CheckRunType
CheckStatusState
CollaboratorAffiliation
CommentAuthorAssociation
CommentCannotUpdateReason
DeploymentState
DeploymentStatusState
GistOrderField
GistPrivacy
GitSignatureState
IssueOrderField
IssueState
IssueTimelineItemsItemType
LanguageOrderField
LockReason
MergeStateStatus
MergeableState
MilestoneOrderField
MilestoneState
OrderDirection
OrganizationInvitationRole
OrganizationInvitationType
ProjectCardArchivedState
ProjectCardState
ProjectColumnPurpose
ProjectOrderField
ProjectState
PullRequestOrderField
PullRequestReviewCommentState
PullRequestReviewEvent
PullRequestReviewState
PullRequestState
PullRequestTimelineItemsItemType
ReactionContent
ReactionOrderField
RefOrderField
ReleaseOrderField
RepositoryAffiliation
RepositoryContributionType
RepositoryLockReason
RepositoryOrderField
RepositoryPermission
RepositoryPrivacy
RequestableCheckStatusState
SearchType
StarOrderField
StatusState
SubscriptionState
TeamDiscussionCommentOrderField
TeamDiscussionOrderField
TeamMemberOrderField
TeamMemberRole
TeamMembershipType
TeamOrderField
TeamPrivacy
TeamRepositoryOrderField
TeamRole
TopicSuggestionDeclineReason
Unions
Closer
CollectionItemContent
IssueOrPullRequest
IssueTimelineItem
IssueTimelineItems
MilestoneItem
ProjectCardItem
PullRequestTimelineItem
PullRequestTimelineItems
PushAllowanceActor
ReferencedSubject
RenamedTitleSubject
RequestedReviewer
ReviewDismissalAllowanceActor
SearchResultItem
Input Objects
CheckAnnotationData
CheckAnnotationRange
CheckRunAction
CheckRunFilter
CheckRunOutput
CheckRunOutputImage
CheckSuiteAutoTriggerPreference
CheckSuiteFilter
CommitAuthor
DraftPullRequestReviewComment
GistOrder
IssueFilters
IssueOrder
LanguageOrder
MilestoneOrder
ProjectOrder
ReactionOrder
RefOrder
ReleaseOrder
RepositoryOrder
StarOrder
TeamDiscussionCommentOrder
TeamDiscussionOrder
TeamMemberOrder
TeamOrder
TeamRepositoryOrder
Scalars
Boolean
DateTime
Float
GitObjectID
GitSSHRemote
GitTimestamp
HTML
ID
Int
String
URI
X509Certificate
