Skip to main content

Objects in GraphQL represent the resources you can access.

In this article

About objects

Objects in GraphQL represent the resources you can access. An object can contain a list of fields, which are specifically typed.

For example, the Repository object has a field called name, which is a String.

For more information, see "Introduction to GraphQL."

ActorLocation

Location information for an actor.

Fields for ActorLocation

NameDescription

city (String)

City.

country (String)

Country name.

countryCode (String)

Country code.

region (String)

Region name.

regionCode (String)

Region or state code.

AddedToMergeQueueEvent

Represents anadded_to_merge_queueevent on a given pull request.

AddedToMergeQueueEvent Implements

Fields for AddedToMergeQueueEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

enqueuer (User)

The user who added this Pull Request to the merge queue.

id (ID!)

The Node ID of the AddedToMergeQueueEvent object.

mergeQueue (MergeQueue)

The merge queue where this pull request was added to.

pullRequest (PullRequest)

PullRequest referenced by event.

AddedToProjectEvent

Represents aadded_to_projectevent on a given issue or pull request.

AddedToProjectEvent Implements

Fields for AddedToProjectEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

id (ID!)

The Node ID of the AddedToProjectEvent object.

project (Project)

Project referenced by event.

projectCard (ProjectCard)

Project card referenced by this project event.

projectColumnName (String!)

Column name referenced by this project event.

App

A GitHub App.

App Implements

Fields for App

NameDescription

clientId (String)

The client ID of the app.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

description (String)

The description of the app.

id (ID!)

The Node ID of the App object.

ipAllowListEntries (IpAllowListEntryConnection!)

The IP addresses of the app.

Arguments for ipAllowListEntries

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

logoBackgroundColor (String!)

The hex color code, without the leading '#', for the logo background.

logoUrl (URI!)

A URL pointing to the app's logo.

Arguments for logoUrl

  • size (Int)

    The size of the resulting image.

name (String!)

The name of the app.

slug (String!)

A slug based on the name of the app for use in URLs.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The URL to the app's homepage.

AssignedEvent

Represents anassignedevent on any assignable object.

AssignedEvent Implements

Fields for AssignedEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

assignable (Assignable!)

Identifies the assignable associated with the event.

assignee (Assignee)

Identifies the user or mannequin that was assigned.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the AssignedEvent object.

user (User)

Identifies the user who was assigned.

Warning

user is deprecated.

Assignees can now be mannequins. Use the assignee field instead. Removal on 2020-01-01 UTC.

AutoMergeDisabledEvent

Represents aauto_merge_disabledevent on a given pull request.

AutoMergeDisabledEvent Implements

Fields for AutoMergeDisabledEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

disabler (User)

The user who disabled auto-merge for this Pull Request.

id (ID!)

The Node ID of the AutoMergeDisabledEvent object.

pullRequest (PullRequest)

PullRequest referenced by event.

reason (String)

The reason auto-merge was disabled.

reasonCode (String)

The reason_code relating to why auto-merge was disabled.

AutoMergeEnabledEvent

Represents aauto_merge_enabledevent on a given pull request.

AutoMergeEnabledEvent Implements

Fields for AutoMergeEnabledEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

enabler (User)

The user who enabled auto-merge for this Pull Request.

id (ID!)

The Node ID of the AutoMergeEnabledEvent object.

pullRequest (PullRequest)

PullRequest referenced by event.

AutoMergeRequest

Represents an auto-merge request for a pull request.

Fields for AutoMergeRequest

NameDescription

authorEmail (String)

The email address of the author of this auto-merge request.

commitBody (String)

The commit message of the auto-merge request. If a merge queue is required by the base branch, this value will be set by the merge queue when merging.

commitHeadline (String)

The commit title of the auto-merge request. If a merge queue is required by the base branch, this value will be set by the merge queue when merging.

enabledAt (DateTime)

When was this auto-merge request was enabled.

enabledBy (Actor)

The actor who created the auto-merge request.

mergeMethod (PullRequestMergeMethod!)

The merge method of the auto-merge request. If a merge queue is required by the base branch, this value will be set by the merge queue when merging.

pullRequest (PullRequest!)

The pull request that this auto-merge request is set against.

AutoRebaseEnabledEvent

Represents aauto_rebase_enabledevent on a given pull request.

AutoRebaseEnabledEvent Implements

Fields for AutoRebaseEnabledEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

enabler (User)

The user who enabled auto-merge (rebase) for this Pull Request.

id (ID!)

The Node ID of the AutoRebaseEnabledEvent object.

pullRequest (PullRequest)

PullRequest referenced by event.

AutoSquashEnabledEvent

Represents aauto_squash_enabledevent on a given pull request.

AutoSquashEnabledEvent Implements

Fields for AutoSquashEnabledEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

enabler (User)

The user who enabled auto-merge (squash) for this Pull Request.

id (ID!)

The Node ID of the AutoSquashEnabledEvent object.

pullRequest (PullRequest)

PullRequest referenced by event.

AutomaticBaseChangeFailedEvent

Represents aautomatic_base_change_failedevent on a given pull request.

AutomaticBaseChangeFailedEvent Implements

Fields for AutomaticBaseChangeFailedEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the AutomaticBaseChangeFailedEvent object.

newBase (String!)

The new base for this PR.

oldBase (String!)

The old base for this PR.

pullRequest (PullRequest!)

PullRequest referenced by event.

AutomaticBaseChangeSucceededEvent

Represents aautomatic_base_change_succeededevent on a given pull request.

AutomaticBaseChangeSucceededEvent Implements

Fields for AutomaticBaseChangeSucceededEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the AutomaticBaseChangeSucceededEvent object.

newBase (String!)

The new base for this PR.

oldBase (String!)

The old base for this PR.

pullRequest (PullRequest!)

PullRequest referenced by event.

BaseRefChangedEvent

Represents abase_ref_changedevent on a given issue or pull request.

BaseRefChangedEvent Implements

Fields for BaseRefChangedEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

currentRefName (String!)

Identifies the name of the base ref for the pull request after it was changed.

databaseId (Int)

Identifies the primary key from the database.

id (ID!)

The Node ID of the BaseRefChangedEvent object.

previousRefName (String!)

Identifies the name of the base ref for the pull request before it was changed.

pullRequest (PullRequest!)

PullRequest referenced by event.

BaseRefDeletedEvent

Represents abase_ref_deletedevent on a given pull request.

BaseRefDeletedEvent Implements

Fields for BaseRefDeletedEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

baseRefName (String)

Identifies the name of the Ref associated with the base_ref_deleted event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the BaseRefDeletedEvent object.

pullRequest (PullRequest)

PullRequest referenced by event.

BaseRefForcePushedEvent

Represents abase_ref_force_pushedevent on a given pull request.

BaseRefForcePushedEvent Implements

Fields for BaseRefForcePushedEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

afterCommit (Commit)

Identifies the after commit SHA for thebase_ref_force_pushedevent.

beforeCommit (Commit)

Identifies the before commit SHA for thebase_ref_force_pushedevent.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the BaseRefForcePushedEvent object.

pullRequest (PullRequest!)

PullRequest referenced by event.

ref (Ref)

Identifies the fully qualified ref name for thebase_ref_force_pushedevent.

Blame

Represents a Git blame.

Fields for Blame

NameDescription

ranges ([BlameRange!]!)

The list of ranges from a Git blame.

BlameRange

Represents a range of information from a Git blame.

Fields for BlameRange

NameDescription

age (Int!)

Identifies the recency of the change, from 1 (new) to 10 (old). This is calculated as a 2-quantile and determines the length of distance between the median age of all the changes in the file and the recency of the current range's change.

commit (Commit!)

Identifies the line author.

endingLine (Int!)

The ending line for the range.

startingLine (Int!)

The starting line for the range.

Blob

Represents a Git blob.

Blob Implements

Fields for Blob

NameDescription

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

byteSize (Int!)

Byte size of Blob object.

commitResourcePath (URI!)

The HTTP path for this Git object.

commitUrl (URI!)

The HTTP URL for this Git object.

id (ID!)

The Node ID of the Blob object.

isBinary (Boolean)

Indicates whether the Blob is binary or text. Returns null if unable to determine the encoding.

isTruncated (Boolean!)

Indicates whether the contents is truncated.

oid (GitObjectID!)

The Git object ID.

repository (Repository!)

The Repository the Git object belongs to.

text (String)

UTF8 text data or null if the Blob is binary.

Bot

A special type of user which takes actions on behalf of GitHub Apps.

Bot Implements

Fields for Bot

NameDescription

avatarUrl (URI!)

A URL pointing to the GitHub App's public avatar.

Arguments for avatarUrl

  • size (Int)

    The size of the resulting square image.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

id (ID!)

The Node ID of the Bot object.

login (String!)

The username of the actor.

resourcePath (URI!)

The HTTP path for this bot.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL for this bot.

BranchNamePatternParameters

Parameters to be used for the branch_name_pattern rule.

Fields for BranchNamePatternParameters

NameDescription

name (String)

How this rule will appear to users.

negate (Boolean!)

If true, the rule will fail if the pattern matches.

operator (String!)

The operator to use for matching.

pattern (String!)

The pattern to match with.

BranchProtectionRule

A branch protection rule.

BranchProtectionRule Implements

Fields for BranchProtectionRule

NameDescription

allowsDeletions (Boolean!)

Can this branch be deleted.

allowsForcePushes (Boolean!)

Are force pushes allowed on this branch.

blocksCreations (Boolean!)

Is branch creation a protected operation.

branchProtectionRuleConflicts (BranchProtectionRuleConflictConnection!)

A list of conflicts matching branches protection rule and other branch protection rules.

Arguments for branchProtectionRuleConflicts

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

bypassForcePushAllowances (BypassForcePushAllowanceConnection!)

A list of actors able to force push for this branch protection rule.

Arguments for bypassForcePushAllowances

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

bypassPullRequestAllowances (BypassPullRequestAllowanceConnection!)

A list of actors able to bypass PRs for this branch protection rule.

Arguments for bypassPullRequestAllowances

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

creator (Actor)

The actor who created this branch protection rule.

databaseId (Int)

Identifies the primary key from the database.

dismissesStaleReviews (Boolean!)

Will new commits pushed to matching branches dismiss pull request review approvals.

id (ID!)

The Node ID of the BranchProtectionRule object.

isAdminEnforced (Boolean!)

Can admins override branch protection.

lockAllowsFetchAndMerge (Boolean!)

Whether users can pull changes from upstream when the branch is locked. Set to true to allow fork syncing. Set to false to prevent fork syncing.

lockBranch (Boolean!)

Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.

matchingRefs (RefConnection!)

Repository refs that are protected by this rule.

Arguments for matchingRefs

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • query (String)

    Filters refs with query on name.

pattern (String!)

Identifies the protection rule pattern.

pushAllowances (PushAllowanceConnection!)

A list push allowances for this branch protection rule.

Arguments for pushAllowances

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

repository (Repository)

The repository associated with this branch protection rule.

requireLastPushApproval (Boolean!)

Whether the most recent push must be approved by someone other than the person who pushed it.

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

requiredDeploymentEnvironments ([String])

List of required deployment environments that must be deployed successfully to update matching branches.

requiredStatusCheckContexts ([String])

List of required status check contexts that must pass for commits to be accepted to matching branches.

requiredStatusChecks ([RequiredStatusCheckDescription!])

List of required status checks that must pass for commits to be accepted to matching branches.

requiresApprovingReviews (Boolean!)

Are approving reviews required to update matching branches.

requiresCodeOwnerReviews (Boolean!)

Are reviews from code owners required to update matching branches.

requiresCommitSignatures (Boolean!)

Are commits required to be signed.

requiresConversationResolution (Boolean!)

Are conversations required to be resolved before merging.

requiresDeployments (Boolean!)

Does this branch require deployment to specific environments before merging.

requiresLinearHistory (Boolean!)

Are merge commits prohibited from being pushed to this branch.

requiresStatusChecks (Boolean!)

Are status checks required to update matching branches.

requiresStrictStatusChecks (Boolean!)

Are branches required to be up to date before merging.

restrictsPushes (Boolean!)

Is pushing to matching branches restricted.

restrictsReviewDismissals (Boolean!)

Is dismissal of pull request reviews restricted.

reviewDismissalAllowances (ReviewDismissalAllowanceConnection!)

A list review dismissal allowances for this branch protection rule.

Arguments for reviewDismissalAllowances

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

BranchProtectionRuleConflict

A conflict between two branch protection rules.

Fields for BranchProtectionRuleConflict

NameDescription

branchProtectionRule (BranchProtectionRule)

Identifies the branch protection rule.

conflictingBranchProtectionRule (BranchProtectionRule)

Identifies the conflicting branch protection rule.

ref (Ref)

Identifies the branch ref that has conflicting rules.

BranchProtectionRuleConflictConnection

The connection type for BranchProtectionRuleConflict.

Fields for BranchProtectionRuleConflictConnection

NameDescription

edges ([BranchProtectionRuleConflictEdge])

A list of edges.

nodes ([BranchProtectionRuleConflict])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

BranchProtectionRuleConflictEdge

An edge in a connection.

Fields for BranchProtectionRuleConflictEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (BranchProtectionRuleConflict)

The item at the end of the edge.

BranchProtectionRuleConnection

The connection type for BranchProtectionRule.

Fields for BranchProtectionRuleConnection

NameDescription

edges ([BranchProtectionRuleEdge])

A list of edges.

nodes ([BranchProtectionRule])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

BranchProtectionRuleEdge

An edge in a connection.

Fields for BranchProtectionRuleEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (BranchProtectionRule)

The item at the end of the edge.

BypassForcePushAllowance

A user, team, or app who has the ability to bypass a force push requirement on a protected branch.

BypassForcePushAllowance Implements

Fields for BypassForcePushAllowance

NameDescription

actor (BranchActorAllowanceActor)

The actor that can force push.

branchProtectionRule (BranchProtectionRule)

Identifies the branch protection rule associated with the allowed user, team, or app.

id (ID!)

The Node ID of the BypassForcePushAllowance object.

BypassForcePushAllowanceConnection

The connection type for BypassForcePushAllowance.

Fields for BypassForcePushAllowanceConnection

NameDescription

edges ([BypassForcePushAllowanceEdge])

A list of edges.

nodes ([BypassForcePushAllowance])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

BypassForcePushAllowanceEdge

An edge in a connection.

Fields for BypassForcePushAllowanceEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (BypassForcePushAllowance)

The item at the end of the edge.

BypassPullRequestAllowance

A user, team, or app who has the ability to bypass a pull request requirement on a protected branch.

BypassPullRequestAllowance Implements

Fields for BypassPullRequestAllowance

NameDescription

actor (BranchActorAllowanceActor)

The actor that can bypass.

branchProtectionRule (BranchProtectionRule)

Identifies the branch protection rule associated with the allowed user, team, or app.

id (ID!)

The Node ID of the BypassPullRequestAllowance object.

BypassPullRequestAllowanceConnection

The connection type for BypassPullRequestAllowance.

Fields for BypassPullRequestAllowanceConnection

NameDescription

edges ([BypassPullRequestAllowanceEdge])

A list of edges.

nodes ([BypassPullRequestAllowance])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

BypassPullRequestAllowanceEdge

An edge in a connection.

Fields for BypassPullRequestAllowanceEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (BypassPullRequestAllowance)

The item at the end of the edge.

CVSS

The Common Vulnerability Scoring System.

Fields for CVSS

NameDescription

score (Float!)

The CVSS score associated with this advisory.

vectorString (String)

The CVSS vector string associated with this advisory.

CWE

A common weakness enumeration.

CWE Implements

Fields for CWE

NameDescription

cweId (String!)

The id of the CWE.

description (String!)

A detailed description of this CWE.

id (ID!)

The Node ID of the CWE object.

name (String!)

The name of this CWE.

CWEConnection

The connection type for CWE.

Fields for CWEConnection

NameDescription

edges ([CWEEdge])

A list of edges.

nodes ([CWE])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

CWEEdge

An edge in a connection.

Fields for CWEEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (CWE)

The item at the end of the edge.

CheckAnnotation

A single check annotation.

Fields for CheckAnnotation

NameDescription

annotationLevel (CheckAnnotationLevel)

The annotation's severity level.

blobUrl (URI!)

The path to the file that this annotation was made on.

databaseId (Int)

Identifies the primary key from the database.

location (CheckAnnotationSpan!)

The position of this annotation.

message (String!)

The annotation's message.

path (String!)

The path that this annotation was made on.

rawDetails (String)

Additional information about the annotation.

title (String)

The annotation's title.

CheckAnnotationConnection

The connection type for CheckAnnotation.

Fields for CheckAnnotationConnection

NameDescription

edges ([CheckAnnotationEdge])

A list of edges.

nodes ([CheckAnnotation])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

CheckAnnotationEdge

An edge in a connection.

Fields for CheckAnnotationEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (CheckAnnotation)

The item at the end of the edge.

CheckAnnotationPosition

A character position in a check annotation.

Fields for CheckAnnotationPosition

NameDescription

column (Int)

Column number (1 indexed).

line (Int!)

Line number (1 indexed).

CheckAnnotationSpan

An inclusive pair of positions for a check annotation.

Fields for CheckAnnotationSpan

NameDescription

end (CheckAnnotationPosition!)

End position (inclusive).

start (CheckAnnotationPosition!)

Start position (inclusive).

CheckRun

A check run.

CheckRun Implements

Fields for CheckRun

NameDescription

annotations (CheckAnnotationConnection)

The check run's annotations.

Arguments for annotations

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

checkSuite (CheckSuite!)

The check suite that this run is a part of.

completedAt (DateTime)

Identifies the date and time when the check run was completed.

conclusion (CheckConclusionState)

The conclusion of the check run.

databaseId (Int)

Identifies the primary key from the database.

deployment (Deployment)

The corresponding deployment for this job, if any.

detailsUrl (URI)

The URL from which to find full details of the check run on the integrator's site.

externalId (String)

A reference for the check run on the integrator's system.

id (ID!)

The Node ID of the CheckRun object.

isRequired (Boolean!)

Whether this is required to pass before merging for a specific pull request.

Arguments for isRequired

  • pullRequestId (ID)

    The id of the pull request this is required for.

  • pullRequestNumber (Int)

    The number of the pull request this is required for.

name (String!)

The name of the check for this check run.

pendingDeploymentRequest (DeploymentRequest)

Information about a pending deployment, if any, in this check run.

permalink (URI!)

The permalink to the check run summary.

repository (Repository!)

The repository associated with this check run.

resourcePath (URI!)

The HTTP path for this check run.

startedAt (DateTime)

Identifies the date and time when the check run was started.

status (CheckStatusState!)

The current status of the check run.

steps (CheckStepConnection)

The check run's steps.

Arguments for steps

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • number (Int)

    Step number.

summary (String)

A string representing the check run's summary.

text (String)

A string representing the check run's text.

title (String)

A string representing the check run.

url (URI!)

The HTTP URL for this check run.

CheckRunConnection

The connection type for CheckRun.

Fields for CheckRunConnection

NameDescription

edges ([CheckRunEdge])

A list of edges.

nodes ([CheckRun])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

CheckRunEdge

An edge in a connection.

Fields for CheckRunEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (CheckRun)

The item at the end of the edge.

CheckRunStateCount

Represents a count of the state of a check run.

Fields for CheckRunStateCount

NameDescription

count (Int!)

The number of check runs with this state.

state (CheckRunState!)

The state of a check run.

CheckStep

A single check step.

Fields for CheckStep

NameDescription

completedAt (DateTime)

Identifies the date and time when the check step was completed.

conclusion (CheckConclusionState)

The conclusion of the check step.

externalId (String)

A reference for the check step on the integrator's system.

name (String!)

The step's name.

number (Int!)

The index of the step in the list of steps of the parent check run.

secondsToCompletion (Int)

Number of seconds to completion.

startedAt (DateTime)

Identifies the date and time when the check step was started.

status (CheckStatusState!)

The current status of the check step.

CheckStepConnection

The connection type for CheckStep.

Fields for CheckStepConnection

NameDescription

edges ([CheckStepEdge])

A list of edges.

nodes ([CheckStep])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

CheckStepEdge

An edge in a connection.

Fields for CheckStepEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (CheckStep)

The item at the end of the edge.

CheckSuite

A check suite.

CheckSuite Implements

Fields for CheckSuite

NameDescription

app (App)

The GitHub App which created this check suite.

branch (Ref)

The name of the branch for this check suite.

checkRuns (CheckRunConnection)

The check runs associated with a check suite.

Arguments for checkRuns

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

commit (Commit!)

The commit for this check suite.

conclusion (CheckConclusionState)

The conclusion of this check suite.

createdAt (DateTime!)

Identifies the date and time when the object was created.

creator (User)

The user who triggered the check suite.

databaseId (Int)

Identifies the primary key from the database.

id (ID!)

The Node ID of the CheckSuite object.

matchingPullRequests (PullRequestConnection)

A list of open pull requests matching the check suite.

Arguments for matchingPullRequests

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • baseRefName (String)

    The base ref name to filter the pull requests by.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • headRefName (String)

    The head ref name to filter the pull requests by.

  • labels ([String!])

    A list of label names to filter the pull requests by.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (IssueOrder)

    Ordering options for pull requests returned from the connection.

push (Push)

The push that triggered this check suite.

repository (Repository!)

The repository associated with this check suite.

resourcePath (URI!)

The HTTP path for this check suite.

status (CheckStatusState!)

The status of this check suite.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL for this check suite.

workflowRun (WorkflowRun)

The workflow run associated with this check suite.

CheckSuiteConnection

The connection type for CheckSuite.

Fields for CheckSuiteConnection

NameDescription

edges ([CheckSuiteEdge])

A list of edges.

nodes ([CheckSuite])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

CheckSuiteEdge

An edge in a connection.

Fields for CheckSuiteEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (CheckSuite)

The item at the end of the edge.

ClosedEvent

Represents aclosedevent on any Closable.

ClosedEvent Implements

Fields for ClosedEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

closable (Closable!)

Object that was closed.

closer (Closer)

Object which triggered the creation of this event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the ClosedEvent object.

resourcePath (URI!)

The HTTP path for this closed event.

stateReason (IssueStateReason)

The reason the issue state was changed to closed.

url (URI!)

The HTTP URL for this closed event.

CodeOfConduct

The Code of Conduct for a repository.

CodeOfConduct Implements

Fields for CodeOfConduct

NameDescription

body (String)

The body of the Code of Conduct.

id (ID!)

The Node ID of the CodeOfConduct object.

key (String!)

The key for the Code of Conduct.

name (String!)

The formal name of the Code of Conduct.

resourcePath (URI)

The HTTP path for this Code of Conduct.

url (URI)

The HTTP URL for this Code of Conduct.

CodeScanningParameters

Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.

Fields for CodeScanningParameters

NameDescription

codeScanningTools ([CodeScanningTool!]!)

Tools that must provide code scanning results for this rule to pass.

CodeScanningTool

A tool that must provide code scanning results for this rule to pass.

Fields for CodeScanningTool

NameDescription

alertsThreshold (String!)

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "About code scanning alerts.".

securityAlertsThreshold (String!)

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "About code scanning alerts.".

tool (String!)

The name of a code scanning tool.

CommentDeletedEvent

Represents acomment_deletedevent on a given issue or pull request.

CommentDeletedEvent Implements

Fields for CommentDeletedEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

deletedCommentAuthor (Actor)

The user who authored the deleted comment.

id (ID!)

The Node ID of the CommentDeletedEvent object.

Commit

Represents a Git commit.

Commit Implements

Fields for Commit

NameDescription

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

additions (Int!)

The number of additions in this commit.

associatedPullRequests (PullRequestConnection)

The merged Pull Request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open Pull Requests associated with the commit.

Arguments for associatedPullRequests

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

author (GitActor)

Authorship details of the commit.

authoredByCommitter (Boolean!)

Check if the committer and the author match.

authoredDate (DateTime!)

The datetime when this commit was authored.

authors (GitActorConnection!)

The list of authors for this commit based on the git author and the Co-authored-by message trailer. The git author will always be first.

Arguments for authors

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

blame (Blame!)

Fetches git blame information.

Arguments for blame

  • path (String!)

    The file whose Git blame information you want.

changedFiles (Int!)

We recommend using the changedFilesIfAvailable field instead of changedFiles, as changedFiles will cause your request to return an error if GitHub is unable to calculate the number of changed files.

Warning

changedFiles is deprecated.

changedFiles will be removed. Use changedFilesIfAvailable instead. Removal on 2023-01-01 UTC.

changedFilesIfAvailable (Int)

The number of changed files in this commit. If GitHub is unable to calculate the number of changed files (for example due to a timeout), this will return null. We recommend using this field instead of changedFiles.

checkSuites (CheckSuiteConnection)

The check suites associated with a commit.

Arguments for checkSuites

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

comments (CommitCommentConnection!)

Comments made on the commit.

Arguments for comments

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

commitResourcePath (URI!)

The HTTP path for this Git object.

commitUrl (URI!)

The HTTP URL for this Git object.

committedDate (DateTime!)

The datetime when this commit was committed.

committedViaWeb (Boolean!)

Check if committed via GitHub web UI.

committer (GitActor)

Committer details of the commit.

deletions (Int!)

The number of deletions in this commit.

deployments (DeploymentConnection)

The deployments associated with a commit.

Arguments for deployments

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • environments ([String!])

    Environments to list deployments for.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (DeploymentOrder)

    Ordering options for deployments returned from the connection.

file (TreeEntry)

The tree entry representing the file located at the given path.

Arguments for file

  • path (String!)

    The path for the file.

history (CommitHistoryConnection!)

The linear commit history starting from (and including) this commit, in the same order as git log.

Arguments for history

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • author (CommitAuthor)

    If non-null, filters history to only show commits with matching authorship.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • path (String)

    If non-null, filters history to only show commits touching files under this path.

  • since (GitTimestamp)

    Allows specifying a beginning time or date for fetching commits. Unexpected results may be returned for dates not between 1970-01-01 and 2099-12-13 (inclusive).

  • until (GitTimestamp)

    Allows specifying an ending time or date for fetching commits. Unexpected results may be returned for dates not between 1970-01-01 and 2099-12-13 (inclusive).

id (ID!)

The Node ID of the Commit object.

message (String!)

The Git commit message.

messageBody (String!)

The Git commit message body.

messageBodyHTML (HTML!)

The commit message body rendered to HTML.

messageHeadline (String!)

The Git commit message headline.

messageHeadlineHTML (HTML!)

The commit message headline rendered to HTML.

oid (GitObjectID!)

The Git object ID.

onBehalfOf (Organization)

The organization this commit was made on behalf of.

parents (CommitConnection!)

The parents of a commit.

Arguments for parents

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

pushedDate (DateTime)

The datetime when this commit was pushed.

Warning

pushedDate is deprecated.

pushedDate is no longer supported. Removal on 2023-07-01 UTC.

repository (Repository!)

The Repository this commit belongs to.

resourcePath (URI!)

The HTTP path for this commit.

signature (GitSignature)

Commit signing information, if present.

status (Status)

Status information for this commit.

statusCheckRollup (StatusCheckRollup)

Check and Status rollup information for this commit.

submodules (SubmoduleConnection!)

Returns a list of all submodules in this repository as of this Commit parsed from the .gitmodules file.

Arguments for submodules

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

tarballUrl (URI!)

Returns a URL to download a tarball archive for a repository. Note: For private repositories, these links are temporary and expire after five minutes.

tree (Tree!)

Commit's root Tree.

treeResourcePath (URI!)

The HTTP path for the tree of this commit.

treeUrl (URI!)

The HTTP URL for the tree of this commit.

url (URI!)

The HTTP URL for this commit.

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

zipballUrl (URI!)

Returns a URL to download a zipball archive for a repository. Note: For private repositories, these links are temporary and expire after five minutes.

CommitAuthorEmailPatternParameters

Parameters to be used for the commit_author_email_pattern rule.

Fields for CommitAuthorEmailPatternParameters

NameDescription

name (String)

How this rule will appear to users.

negate (Boolean!)

If true, the rule will fail if the pattern matches.

operator (String!)

The operator to use for matching.

pattern (String!)

The pattern to match with.

CommitComment

Represents a comment on a given Commit.

CommitComment Implements

Fields for CommitComment

NameDescription

author (Actor)

The actor who authored the comment.

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

body (String!)

Identifies the comment body.

bodyHTML (HTML!)

The body rendered to HTML.

bodyText (String!)

The body rendered to text.

commit (Commit)

Identifies the commit associated with the comment, if the commit exists.

createdAt (DateTime!)

Identifies the date and time when the object was created.

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

databaseId (Int)

Identifies the primary key from the database.

editor (Actor)

The actor who edited the comment.

id (ID!)

The Node ID of the CommitComment object.

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

lastEditedAt (DateTime)

The moment the editor made the last edit.

minimizedReason (String)

Returns why the comment was minimized. One of abuse, off-topic, outdated, resolved, duplicate and spam. Note that the case and formatting of these values differs from the inputs to the MinimizeComment mutation.

path (String)

Identifies the file path associated with the comment.

position (Int)

Identifies the line position associated with the comment.

publishedAt (DateTime)

Identifies when the comment was published at.

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

Arguments for reactions

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (ReactionOrder)

    Allows specifying the order in which reactions are returned.

repository (Repository!)

The repository associated with this node.

resourcePath (URI!)

The HTTP path permalink for this commit comment.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL permalink for this commit comment.

userContentEdits (UserContentEditConnection)

A list of edits to this content.

Arguments for userContentEdits

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

viewerCanReact (Boolean!)

Can user react to this subject.

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

CommitCommentConnection

The connection type for CommitComment.

Fields for CommitCommentConnection

NameDescription

edges ([CommitCommentEdge])

A list of edges.

nodes ([CommitComment])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

CommitCommentEdge

An edge in a connection.

Fields for CommitCommentEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (CommitComment)

The item at the end of the edge.

CommitCommentThread

A thread of comments on a commit.

CommitCommentThread Implements

Fields for CommitCommentThread

NameDescription

comments (CommitCommentConnection!)

The comments that exist in this thread.

Arguments for comments

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

commit (Commit)

The commit the comments were made on.

id (ID!)

The Node ID of the CommitCommentThread object.

path (String)

The file the comments were made on.

position (Int)

The position in the diff for the commit that the comment was made on.

repository (Repository!)

The repository associated with this node.

CommitConnection

The connection type for Commit.

Fields for CommitConnection

NameDescription

edges ([CommitEdge])

A list of edges.

nodes ([Commit])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

CommitContributionsByRepository

This aggregates commits made by a user within one repository.

Fields for CommitContributionsByRepository

NameDescription

contributions (CreatedCommitContributionConnection!)

The commit contributions, each representing a day.

Arguments for contributions

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

repository (Repository!)

The repository in which the commits were made.

resourcePath (URI!)

The HTTP path for the user's commits to the repository in this time range.

url (URI!)

The HTTP URL for the user's commits to the repository in this time range.

CommitEdge

An edge in a connection.

Fields for CommitEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (Commit)

The item at the end of the edge.

CommitHistoryConnection

The connection type for Commit.

Fields for CommitHistoryConnection

NameDescription

edges ([CommitEdge])

A list of edges.

nodes ([Commit])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

CommitMessagePatternParameters

Parameters to be used for the commit_message_pattern rule.

Fields for CommitMessagePatternParameters

NameDescription

name (String)

How this rule will appear to users.

negate (Boolean!)

If true, the rule will fail if the pattern matches.

operator (String!)

The operator to use for matching.

pattern (String!)

The pattern to match with.

CommitterEmailPatternParameters

Parameters to be used for the committer_email_pattern rule.

Fields for CommitterEmailPatternParameters

NameDescription

name (String)

How this rule will appear to users.

negate (Boolean!)

If true, the rule will fail if the pattern matches.

operator (String!)

The operator to use for matching.

pattern (String!)

The pattern to match with.

Comparison

Represents a comparison between two commit revisions.

Comparison Implements

Fields for Comparison

NameDescription

aheadBy (Int!)

The number of commits ahead of the base branch.

baseTarget (GitObject!)

The base revision of this comparison.

behindBy (Int!)

The number of commits behind the base branch.

commits (ComparisonCommitConnection!)

The commits which compose this comparison.

Arguments for commits

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

headTarget (GitObject!)

The head revision of this comparison.

id (ID!)

The Node ID of the Comparison object.

status (ComparisonStatus!)

The status of this comparison.

ComparisonCommitConnection

The connection type for Commit.

Fields for ComparisonCommitConnection

NameDescription

authorCount (Int!)

The total count of authors and co-authors across all commits.

edges ([CommitEdge])

A list of edges.

nodes ([Commit])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

ConnectedEvent

Represents aconnectedevent on a given issue or pull request.

ConnectedEvent Implements

Fields for ConnectedEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the ConnectedEvent object.

isCrossRepository (Boolean!)

Reference originated in a different repository.

source (ReferencedSubject!)

Issue or pull request that made the reference.

subject (ReferencedSubject!)

Issue or pull request which was connected.

ContributingGuidelines

The Contributing Guidelines for a repository.

Fields for ContributingGuidelines

NameDescription

body (String)

The body of the Contributing Guidelines.

resourcePath (URI)

The HTTP path for the Contributing Guidelines.

url (URI)

The HTTP URL for the Contributing Guidelines.

ContributionCalendar

A calendar of contributions made on GitHub by a user.

Fields for ContributionCalendar

NameDescription

colors ([String!]!)

A list of hex color codes used in this calendar. The darker the color, the more contributions it represents.

isHalloween (Boolean!)

Determine if the color set was chosen because it's currently Halloween.

months ([ContributionCalendarMonth!]!)

A list of the months of contributions in this calendar.

totalContributions (Int!)

The count of total contributions in the calendar.

weeks ([ContributionCalendarWeek!]!)

A list of the weeks of contributions in this calendar.

ContributionCalendarDay

Represents a single day of contributions on GitHub by a user.

Fields for ContributionCalendarDay

NameDescription

color (String!)

The hex color code that represents how many contributions were made on this day compared to others in the calendar.

contributionCount (Int!)

How many contributions were made by the user on this day.

contributionLevel (ContributionLevel!)

Indication of contributions, relative to other days. Can be used to indicate which color to represent this day on a calendar.

date (Date!)

The day this square represents.

weekday (Int!)

A number representing which day of the week this square represents, e.g., 1 is Monday.

ContributionCalendarMonth

A month of contributions in a user's contribution graph.

Fields for ContributionCalendarMonth

NameDescription

firstDay (Date!)

The date of the first day of this month.

name (String!)

The name of the month.

totalWeeks (Int!)

How many weeks started in this month.

year (Int!)

The year the month occurred in.

ContributionCalendarWeek

A week of contributions in a user's contribution graph.

Fields for ContributionCalendarWeek

NameDescription

contributionDays ([ContributionCalendarDay!]!)

The days of contributions in this week.

firstDay (Date!)

The date of the earliest square in this week.

ContributionsCollection

A contributions collection aggregates contributions such as opened issues and commits created by a user.

Fields for ContributionsCollection

NameDescription

commitContributionsByRepository ([CommitContributionsByRepository!]!)

Commit contributions made by the user, grouped by repository.

Arguments for commitContributionsByRepository

  • maxRepositories (Int)

    How many repositories should be included.

    The default value is 25.

contributionCalendar (ContributionCalendar!)

A calendar of this user's contributions on GitHub.

contributionYears ([Int!]!)

The years the user has been making contributions with the most recent year first.

doesEndInCurrentMonth (Boolean!)

Determine if this collection's time span ends in the current month.

earliestRestrictedContributionDate (Date)

The date of the first restricted contribution the user made in this time period. Can only be non-null when the user has enabled private contribution counts.

endedAt (DateTime!)

The ending date and time of this collection.

firstIssueContribution (CreatedIssueOrRestrictedContribution)

The first issue the user opened on GitHub. This will be null if that issue was opened outside the collection's time range and ignoreTimeRange is false. If the issue is not visible but the user has opted to show private contributions, a RestrictedContribution will be returned.

firstPullRequestContribution (CreatedPullRequestOrRestrictedContribution)

The first pull request the user opened on GitHub. This will be null if that pull request was opened outside the collection's time range and ignoreTimeRange is not true. If the pull request is not visible but the user has opted to show private contributions, a RestrictedContribution will be returned.

firstRepositoryContribution (CreatedRepositoryOrRestrictedContribution)

The first repository the user created on GitHub. This will be null if that first repository was created outside the collection's time range and ignoreTimeRange is false. If the repository is not visible, then a RestrictedContribution is returned.

hasActivityInThePast (Boolean!)

Does the user have any more activity in the timeline that occurred prior to the collection's time range?.

hasAnyContributions (Boolean!)

Determine if there are any contributions in this collection.

hasAnyRestrictedContributions (Boolean!)

Determine if the user made any contributions in this time frame whose details are not visible because they were made in a private repository. Can only be true if the user enabled private contribution counts.

isSingleDay (Boolean!)

Whether or not the collector's time span is all within the same day.

issueContributions (CreatedIssueContributionConnection!)

A list of issues the user opened.

Arguments for issueContributions

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • excludeFirst (Boolean)

    Should the user's first issue ever be excluded from the result.

    The default value is false.

  • excludePopular (Boolean)

    Should the user's most commented issue be excluded from the result.

    The default value is false.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (ContributionOrder)

    Ordering options for contributions returned from the connection.

issueContributionsByRepository ([IssueContributionsByRepository!]!)

Issue contributions made by the user, grouped by repository.

Arguments for issueContributionsByRepository

  • excludeFirst (Boolean)

    Should the user's first issue ever be excluded from the result.

    The default value is false.

  • excludePopular (Boolean)

    Should the user's most commented issue be excluded from the result.

    The default value is false.

  • maxRepositories (Int)

    How many repositories should be included.

    The default value is 25.

joinedGitHubContribution (JoinedGitHubContribution)

When the user signed up for GitHub. This will be null if that sign up date falls outside the collection's time range and ignoreTimeRange is false.

latestRestrictedContributionDate (Date)

The date of the most recent restricted contribution the user made in this time period. Can only be non-null when the user has enabled private contribution counts.

mostRecentCollectionWithActivity (ContributionsCollection)

When this collection's time range does not include any activity from the user, use this to get a different collection from an earlier time range that does have activity.

mostRecentCollectionWithoutActivity (ContributionsCollection)

Returns a different contributions collection from an earlier time range than this one that does not have any contributions.

popularIssueContribution (CreatedIssueContribution)

The issue the user opened on GitHub that received the most comments in the specified time frame.

popularPullRequestContribution (CreatedPullRequestContribution)

The pull request the user opened on GitHub that received the most comments in the specified time frame.

pullRequestContributions (CreatedPullRequestContributionConnection!)

Pull request contributions made by the user.

Arguments for pullRequestContributions

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • excludeFirst (Boolean)

    Should the user's first pull request ever be excluded from the result.

    The default value is false.

  • excludePopular (Boolean)

    Should the user's most commented pull request be excluded from the result.

    The default value is false.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (ContributionOrder)

    Ordering options for contributions returned from the connection.

pullRequestContributionsByRepository ([PullRequestContributionsByRepository!]!)

Pull request contributions made by the user, grouped by repository.

Arguments for pullRequestContributionsByRepository

  • excludeFirst (Boolean)

    Should the user's first pull request ever be excluded from the result.

    The default value is false.

  • excludePopular (Boolean)

    Should the user's most commented pull request be excluded from the result.

    The default value is false.

  • maxRepositories (Int)

    How many repositories should be included.

    The default value is 25.

pullRequestReviewContributions (CreatedPullRequestReviewContributionConnection!)

Pull request review contributions made by the user. Returns the most recently submitted review for each PR reviewed by the user.

Arguments for pullRequestReviewContributions

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (ContributionOrder)

    Ordering options for contributions returned from the connection.

pullRequestReviewContributionsByRepository ([PullRequestReviewContributionsByRepository!]!)

Pull request review contributions made by the user, grouped by repository.

Arguments for pullRequestReviewContributionsByRepository

  • maxRepositories (Int)

    How many repositories should be included.

    The default value is 25.

repositoryContributions (CreatedRepositoryContributionConnection!)

A list of repositories owned by the user that the user created in this time range.

Arguments for repositoryContributions

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • excludeFirst (Boolean)

    Should the user's first repository ever be excluded from the result.

    The default value is false.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (ContributionOrder)

    Ordering options for contributions returned from the connection.

restrictedContributionsCount (Int!)

A count of contributions made by the user that the viewer cannot access. Only non-zero when the user has chosen to share their private contribution counts.

startedAt (DateTime!)

The beginning date and time of this collection.

totalCommitContributions (Int!)

How many commits were made by the user in this time span.

totalIssueContributions (Int!)

How many issues the user opened.

Arguments for totalIssueContributions

  • excludeFirst (Boolean)

    Should the user's first issue ever be excluded from this count.

    The default value is false.

  • excludePopular (Boolean)

    Should the user's most commented issue be excluded from this count.

    The default value is false.

totalPullRequestContributions (Int!)

How many pull requests the user opened.

Arguments for totalPullRequestContributions

  • excludeFirst (Boolean)

    Should the user's first pull request ever be excluded from this count.

    The default value is false.

  • excludePopular (Boolean)

    Should the user's most commented pull request be excluded from this count.

    The default value is false.

totalPullRequestReviewContributions (Int!)

How many pull request reviews the user left.

totalRepositoriesWithContributedCommits (Int!)

How many different repositories the user committed to.

totalRepositoriesWithContributedIssues (Int!)

How many different repositories the user opened issues in.

Arguments for totalRepositoriesWithContributedIssues

  • excludeFirst (Boolean)

    Should the user's first issue ever be excluded from this count.

    The default value is false.

  • excludePopular (Boolean)

    Should the user's most commented issue be excluded from this count.

    The default value is false.

totalRepositoriesWithContributedPullRequestReviews (Int!)

How many different repositories the user left pull request reviews in.

totalRepositoriesWithContributedPullRequests (Int!)

How many different repositories the user opened pull requests in.

Arguments for totalRepositoriesWithContributedPullRequests

  • excludeFirst (Boolean)

    Should the user's first pull request ever be excluded from this count.

    The default value is false.

  • excludePopular (Boolean)

    Should the user's most commented pull request be excluded from this count.

    The default value is false.

totalRepositoryContributions (Int!)

How many repositories the user created.

Arguments for totalRepositoryContributions

  • excludeFirst (Boolean)

    Should the user's first repository ever be excluded from this count.

    The default value is false.

user (User!)

The user who made the contributions in this collection.

ConvertToDraftEvent

Represents aconvert_to_draftevent on a given pull request.

ConvertToDraftEvent Implements

Fields for ConvertToDraftEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the ConvertToDraftEvent object.

pullRequest (PullRequest!)

PullRequest referenced by event.

resourcePath (URI!)

The HTTP path for this convert to draft event.

url (URI!)

The HTTP URL for this convert to draft event.

ConvertedNoteToIssueEvent

Represents aconverted_note_to_issueevent on a given issue or pull request.

ConvertedNoteToIssueEvent Implements

Fields for ConvertedNoteToIssueEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

id (ID!)

The Node ID of the ConvertedNoteToIssueEvent object.

project (Project)

Project referenced by event.

projectCard (ProjectCard)

Project card referenced by this project event.

projectColumnName (String!)

Column name referenced by this project event.

ConvertedToDiscussionEvent

Represents aconverted_to_discussionevent on a given issue.

ConvertedToDiscussionEvent Implements

Fields for ConvertedToDiscussionEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

discussion (Discussion)

The discussion that the issue was converted into.

id (ID!)

The Node ID of the ConvertedToDiscussionEvent object.

CopilotEndpoints

Copilot endpoint information.

Fields for CopilotEndpoints

NameDescription

api (String!)

Copilot API endpoint.

originTracker (String!)

Copilot origin tracker endpoint.

proxy (String!)

Copilot proxy endpoint.

telemetry (String!)

Copilot telemetry endpoint.

CreatedCommitContribution

Represents the contribution a user made by committing to a repository.

CreatedCommitContribution Implements

Fields for CreatedCommitContribution

NameDescription

commitCount (Int!)

How many commits were made on this day to this repository by the user.

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access.

occurredAt (DateTime!)

When this contribution was made.

repository (Repository!)

The repository the user made a commit in.

resourcePath (URI!)

The HTTP path for this contribution.

url (URI!)

The HTTP URL for this contribution.

user (User!)

The user who made this contribution.

CreatedCommitContributionConnection

The connection type for CreatedCommitContribution.

Fields for CreatedCommitContributionConnection

NameDescription

edges ([CreatedCommitContributionEdge])

A list of edges.

nodes ([CreatedCommitContribution])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of commits across days and repositories in the connection.

CreatedCommitContributionEdge

An edge in a connection.

Fields for CreatedCommitContributionEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (CreatedCommitContribution)

The item at the end of the edge.

CreatedIssueContribution

Represents the contribution a user made on GitHub by opening an issue.

CreatedIssueContribution Implements

Fields for CreatedIssueContribution

NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access.

issue (Issue!)

The issue that was opened.

occurredAt (DateTime!)

When this contribution was made.

resourcePath (URI!)

The HTTP path for this contribution.

url (URI!)

The HTTP URL for this contribution.

user (User!)

The user who made this contribution.

CreatedIssueContributionConnection

The connection type for CreatedIssueContribution.

Fields for CreatedIssueContributionConnection

NameDescription

edges ([CreatedIssueContributionEdge])

A list of edges.

nodes ([CreatedIssueContribution])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

CreatedIssueContributionEdge

An edge in a connection.

Fields for CreatedIssueContributionEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (CreatedIssueContribution)

The item at the end of the edge.

CreatedPullRequestContribution

Represents the contribution a user made on GitHub by opening a pull request.

CreatedPullRequestContribution Implements

Fields for CreatedPullRequestContribution

NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access.

occurredAt (DateTime!)

When this contribution was made.

pullRequest (PullRequest!)

The pull request that was opened.

resourcePath (URI!)

The HTTP path for this contribution.

url (URI!)

The HTTP URL for this contribution.

user (User!)

The user who made this contribution.

CreatedPullRequestContributionConnection

The connection type for CreatedPullRequestContribution.

Fields for CreatedPullRequestContributionConnection

NameDescription

edges ([CreatedPullRequestContributionEdge])

A list of edges.

nodes ([CreatedPullRequestContribution])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

CreatedPullRequestContributionEdge

An edge in a connection.

Fields for CreatedPullRequestContributionEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (CreatedPullRequestContribution)

The item at the end of the edge.

CreatedPullRequestReviewContribution

Represents the contribution a user made by leaving a review on a pull request.

CreatedPullRequestReviewContribution Implements

Fields for CreatedPullRequestReviewContribution

NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access.

occurredAt (DateTime!)

When this contribution was made.

pullRequest (PullRequest!)

The pull request the user reviewed.

pullRequestReview (PullRequestReview!)

The review the user left on the pull request.

repository (Repository!)

The repository containing the pull request that the user reviewed.

resourcePath (URI!)

The HTTP path for this contribution.

url (URI!)

The HTTP URL for this contribution.

user (User!)

The user who made this contribution.

CreatedPullRequestReviewContributionConnection

The connection type for CreatedPullRequestReviewContribution.

Fields for CreatedPullRequestReviewContributionConnection

NameDescription

edges ([CreatedPullRequestReviewContributionEdge])

A list of edges.

nodes ([CreatedPullRequestReviewContribution])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

CreatedPullRequestReviewContributionEdge

An edge in a connection.

Fields for CreatedPullRequestReviewContributionEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (CreatedPullRequestReviewContribution)

The item at the end of the edge.

CreatedRepositoryContribution

Represents the contribution a user made on GitHub by creating a repository.

CreatedRepositoryContribution Implements

Fields for CreatedRepositoryContribution

NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access.

occurredAt (DateTime!)

When this contribution was made.

repository (Repository!)

The repository that was created.

resourcePath (URI!)

The HTTP path for this contribution.

url (URI!)

The HTTP URL for this contribution.

user (User!)

The user who made this contribution.

CreatedRepositoryContributionConnection

The connection type for CreatedRepositoryContribution.

Fields for CreatedRepositoryContributionConnection

NameDescription

edges ([CreatedRepositoryContributionEdge])

A list of edges.

nodes ([CreatedRepositoryContribution])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

CreatedRepositoryContributionEdge

An edge in a connection.

Fields for CreatedRepositoryContributionEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (CreatedRepositoryContribution)

The item at the end of the edge.

CrossReferencedEvent

Represents a mention made by one issue or pull request to another.

CrossReferencedEvent Implements

Fields for CrossReferencedEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the CrossReferencedEvent object.

isCrossRepository (Boolean!)

Reference originated in a different repository.

referencedAt (DateTime!)

Identifies when the reference was made.

resourcePath (URI!)

The HTTP path for this pull request.

source (ReferencedSubject!)

Issue or pull request that made the reference.

target (ReferencedSubject!)

Issue or pull request to which the reference was made.

url (URI!)

The HTTP URL for this pull request.

willCloseTarget (Boolean!)

Checks if the target will be closed when the source is merged.

DemilestonedEvent

Represents ademilestonedevent on a given issue or pull request.

DemilestonedEvent Implements

Fields for DemilestonedEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the DemilestonedEvent object.

milestoneTitle (String!)

Identifies the milestone title associated with thedemilestonedevent.

subject (MilestoneItem!)

Object referenced by event.

DependabotUpdate

A Dependabot Update for a dependency in a repository.

DependabotUpdate Implements

Fields for DependabotUpdate

NameDescription

error (DependabotUpdateError)

The error from a dependency update.

pullRequest (PullRequest)

The associated pull request.

repository (Repository!)

The repository associated with this node.

DependabotUpdateError

An error produced from a Dependabot Update.

Fields for DependabotUpdateError

NameDescription

body (String!)

The body of the error.

errorType (String!)

The error code.

title (String!)

The title of the error.

DependencyGraphDependency

A dependency manifest entry.

Fields for DependencyGraphDependency

NameDescription

hasDependencies (Boolean!)

Does the dependency itself have dependencies?.

packageLabel (String!)

The original name of the package, as it appears in the manifest.

Warning

packageLabel is deprecated.

packageLabel will be removed. Use normalized packageName field instead. Removal on 2022-10-01 UTC.

packageManager (String)

The dependency package manager.

packageName (String!)

The name of the package in the canonical form used by the package manager.

repository (Repository)

The repository containing the package.

requirements (String!)

The dependency version requirements.

DependencyGraphDependencyConnection

The connection type for DependencyGraphDependency.

Fields for DependencyGraphDependencyConnection

NameDescription

edges ([DependencyGraphDependencyEdge])

A list of edges.

nodes ([DependencyGraphDependency])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

DependencyGraphDependencyEdge

An edge in a connection.

Fields for DependencyGraphDependencyEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (DependencyGraphDependency)

The item at the end of the edge.

DependencyGraphManifest

Dependency manifest for a repository.

DependencyGraphManifest Implements

Fields for DependencyGraphManifest

NameDescription

blobPath (String!)

Path to view the manifest file blob.

dependencies (DependencyGraphDependencyConnection)

A list of manifest dependencies.

Arguments for dependencies

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

dependenciesCount (Int)

The number of dependencies listed in the manifest.

exceedsMaxSize (Boolean!)

Is the manifest too big to parse?.

filename (String!)

Fully qualified manifest filename.

id (ID!)

The Node ID of the DependencyGraphManifest object.

parseable (Boolean!)

Were we able to parse the manifest?.

repository (Repository!)

The repository containing the manifest.

DependencyGraphManifestConnection

The connection type for DependencyGraphManifest.

Fields for DependencyGraphManifestConnection

NameDescription

edges ([DependencyGraphManifestEdge])

A list of edges.

nodes ([DependencyGraphManifest])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

DependencyGraphManifestEdge

An edge in a connection.

Fields for DependencyGraphManifestEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (DependencyGraphManifest)

The item at the end of the edge.

DeployKey

A repository deploy key.

DeployKey Implements

Fields for DeployKey

NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the DeployKey object.

key (String!)

The deploy key.

readOnly (Boolean!)

Whether or not the deploy key is read only.

title (String!)

The deploy key title.

verified (Boolean!)

Whether or not the deploy key has been verified.

DeployKeyConnection

The connection type for DeployKey.

Fields for DeployKeyConnection

NameDescription

edges ([DeployKeyEdge])

A list of edges.

nodes ([DeployKey])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

DeployKeyEdge

An edge in a connection.

Fields for DeployKeyEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (DeployKey)

The item at the end of the edge.

DeployedEvent

Represents adeployedevent on a given pull request.

DeployedEvent Implements

Fields for DeployedEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

deployment (Deployment!)

The deployment associated with thedeployedevent.

id (ID!)

The Node ID of the DeployedEvent object.

pullRequest (PullRequest!)

PullRequest referenced by event.

ref (Ref)

The ref associated with thedeployedevent.

Deployment

Represents triggered deployment instance.

Deployment Implements

Fields for Deployment

NameDescription

commit (Commit)

Identifies the commit sha of the deployment.

commitOid (String!)

Identifies the oid of the deployment commit, even if the commit has been deleted.

createdAt (DateTime!)

Identifies the date and time when the object was created.

creator (Actor!)

Identifies the actor who triggered the deployment.

databaseId (Int)

Identifies the primary key from the database.

description (String)

The deployment description.

environment (String)

The latest environment to which this deployment was made.

id (ID!)

The Node ID of the Deployment object.

latestEnvironment (String)

The latest environment to which this deployment was made.

latestStatus (DeploymentStatus)

The latest status of this deployment.

originalEnvironment (String)

The original environment to which this deployment was made.

payload (String)

Extra information that a deployment system might need.

ref (Ref)

Identifies the Ref of the deployment, if the deployment was created by ref.

repository (Repository!)

Identifies the repository associated with the deployment.

state (DeploymentState)

The current state of the deployment.

statuses (DeploymentStatusConnection)

A list of statuses associated with the deployment.

Arguments for statuses

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

task (String)

The deployment task.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

DeploymentConnection

The connection type for Deployment.

Fields for DeploymentConnection

NameDescription

edges ([DeploymentEdge])

A list of edges.

nodes ([Deployment])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

DeploymentEdge

An edge in a connection.

Fields for DeploymentEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (Deployment)

The item at the end of the edge.

DeploymentEnvironmentChangedEvent

Represents adeployment_environment_changedevent on a given pull request.

DeploymentEnvironmentChangedEvent Implements

Fields for DeploymentEnvironmentChangedEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

deploymentStatus (DeploymentStatus!)

The deployment status that updated the deployment environment.

id (ID!)

The Node ID of the DeploymentEnvironmentChangedEvent object.

pullRequest (PullRequest!)

PullRequest referenced by event.

DeploymentProtectionRule

A protection rule.

Fields for DeploymentProtectionRule

NameDescription

databaseId (Int)

Identifies the primary key from the database.

preventSelfReview (Boolean)

Whether deployments to this environment can be approved by the user who created the deployment.

reviewers (DeploymentReviewerConnection!)

The teams or users that can review the deployment.

Arguments for reviewers

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

timeout (Int!)

The timeout in minutes for this protection rule.

type (DeploymentProtectionRuleType!)

The type of protection rule.

DeploymentProtectionRuleConnection

The connection type for DeploymentProtectionRule.

Fields for DeploymentProtectionRuleConnection

NameDescription

edges ([DeploymentProtectionRuleEdge])

A list of edges.

nodes ([DeploymentProtectionRule])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

DeploymentProtectionRuleEdge

An edge in a connection.

Fields for DeploymentProtectionRuleEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (DeploymentProtectionRule)

The item at the end of the edge.

DeploymentRequest

A request to deploy a workflow run to an environment.

Fields for DeploymentRequest

NameDescription

currentUserCanApprove (Boolean!)

Whether or not the current user can approve the deployment.

environment (Environment!)

The target environment of the deployment.

reviewers (DeploymentReviewerConnection!)

The teams or users that can review the deployment.

Arguments for reviewers

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

waitTimer (Int!)

The wait timer in minutes configured in the environment.

waitTimerStartedAt (DateTime)

The wait timer in minutes configured in the environment.

DeploymentRequestConnection

The connection type for DeploymentRequest.

Fields for DeploymentRequestConnection

NameDescription

edges ([DeploymentRequestEdge])

A list of edges.

nodes ([DeploymentRequest])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

DeploymentRequestEdge

An edge in a connection.

Fields for DeploymentRequestEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (DeploymentRequest)

The item at the end of the edge.

DeploymentReview

A deployment review.

DeploymentReview Implements

Fields for DeploymentReview

NameDescription

comment (String!)

The comment the user left.

databaseId (Int)

Identifies the primary key from the database.

environments (EnvironmentConnection!)

The environments approved or rejected.

Arguments for environments

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

id (ID!)

The Node ID of the DeploymentReview object.

state (DeploymentReviewState!)

The decision of the user.

user (User!)

The user that reviewed the deployment.

DeploymentReviewConnection

The connection type for DeploymentReview.

Fields for DeploymentReviewConnection

NameDescription

edges ([DeploymentReviewEdge])

A list of edges.

nodes ([DeploymentReview])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

DeploymentReviewEdge

An edge in a connection.

Fields for DeploymentReviewEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (DeploymentReview)

The item at the end of the edge.

DeploymentReviewerConnection

The connection type for DeploymentReviewer.

Fields for DeploymentReviewerConnection

NameDescription

edges ([DeploymentReviewerEdge])

A list of edges.

nodes ([DeploymentReviewer])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

DeploymentReviewerEdge

An edge in a connection.

Fields for DeploymentReviewerEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (DeploymentReviewer)

The item at the end of the edge.

DeploymentStatus

Describes the status of a given deployment attempt.

DeploymentStatus Implements

Fields for DeploymentStatus

NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

creator (Actor!)

Identifies the actor who triggered the deployment.

deployment (Deployment!)

Identifies the deployment associated with status.

description (String)

Identifies the description of the deployment.

environment (String)

Identifies the environment of the deployment at the time of this deployment status.

environmentUrl (URI)

Identifies the environment URL of the deployment.

id (ID!)

The Node ID of the DeploymentStatus object.

logUrl (URI)

Identifies the log URL of the deployment.

state (DeploymentStatusState!)

Identifies the current state of the deployment.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

DeploymentStatusConnection

The connection type for DeploymentStatus.

Fields for DeploymentStatusConnection

NameDescription

edges ([DeploymentStatusEdge])

A list of edges.

nodes ([DeploymentStatus])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

DeploymentStatusEdge

An edge in a connection.

Fields for DeploymentStatusEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (DeploymentStatus)

The item at the end of the edge.

DisconnectedEvent

Represents adisconnectedevent on a given issue or pull request.

DisconnectedEvent Implements

Fields for DisconnectedEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the DisconnectedEvent object.

isCrossRepository (Boolean!)

Reference originated in a different repository.

source (ReferencedSubject!)

Issue or pull request from which the issue was disconnected.

subject (ReferencedSubject!)

Issue or pull request which was disconnected.

Discussion

A discussion in a repository.

Discussion Implements

Fields for Discussion

NameDescription

activeLockReason (LockReason)

Reason that the conversation was locked.

answer (DiscussionComment)

The comment chosen as this discussion's answer, if any.

answerChosenAt (DateTime)

The time when a user chose this discussion's answer, if answered.

answerChosenBy (Actor)

The user who chose this discussion's answer, if answered.

author (Actor)

The actor who authored the comment.

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

body (String!)

The main text of the discussion post.

bodyHTML (HTML!)

The body rendered to HTML.

bodyText (String!)

The body rendered to text.

category (DiscussionCategory!)

The category for this discussion.

closed (Boolean!)

Indicates if the object is closed (definition of closed may depend on type).

closedAt (DateTime)

Identifies the date and time when the object was closed.

comments (DiscussionCommentConnection!)

The replies to the discussion.

Arguments for comments

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

createdAt (DateTime!)

Identifies the date and time when the object was created.

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

databaseId (Int)

Identifies the primary key from the database.

editor (Actor)

The actor who edited the comment.

id (ID!)

The Node ID of the Discussion object.

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

isAnswered (Boolean)

Only return answered/unanswered discussions.

labels (LabelConnection)

A list of labels associated with the object.

Arguments for labels

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (LabelOrder)

    Ordering options for labels returned from the connection.

lastEditedAt (DateTime)

The moment the editor made the last edit.

locked (Boolean!)

true if the object is locked.

number (Int!)

The number identifying this discussion within the repository.

poll (DiscussionPoll)

The poll associated with this discussion, if one exists.

publishedAt (DateTime)

Identifies when the comment was published at.

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

Arguments for reactions

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (ReactionOrder)

    Allows specifying the order in which reactions are returned.

repository (Repository!)

The repository associated with this node.

resourcePath (URI!)

The path for this discussion.

stateReason (DiscussionStateReason)

Identifies the reason for the discussion's state.

title (String!)

The title of this discussion.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

upvoteCount (Int!)

Number of upvotes that this subject has received.

url (URI!)

The URL for this discussion.

userContentEdits (UserContentEditConnection)

A list of edits to this content.

Arguments for userContentEdits

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

viewerCanClose (Boolean!)

Indicates if the object can be closed by the viewer.

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

viewerCanLabel (Boolean!)

Indicates if the viewer can edit labels for this object.

viewerCanReact (Boolean!)

Can user react to this subject.

viewerCanReopen (Boolean!)

Indicates if the object can be reopened by the viewer.

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

viewerCanUpvote (Boolean!)

Whether or not the current user can add or remove an upvote on this subject.

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

viewerHasUpvoted (Boolean!)

Whether or not the current user has already upvoted this subject.

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

DiscussionCategory

A category for discussions in a repository.

DiscussionCategory Implements

Fields for DiscussionCategory

NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

description (String)

A description of this category.

emoji (String!)

An emoji representing this category.

emojiHTML (HTML!)

This category's emoji rendered as HTML.

id (ID!)

The Node ID of the DiscussionCategory object.

isAnswerable (Boolean!)

Whether or not discussions in this category support choosing an answer with the markDiscussionCommentAsAnswer mutation.

name (String!)

The name of this category.

repository (Repository!)

The repository associated with this node.

slug (String!)

The slug of this category.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

DiscussionCategoryConnection

The connection type for DiscussionCategory.

Fields for DiscussionCategoryConnection

NameDescription

edges ([DiscussionCategoryEdge])

A list of edges.

nodes ([DiscussionCategory])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

DiscussionCategoryEdge

An edge in a connection.

Fields for DiscussionCategoryEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (DiscussionCategory)

The item at the end of the edge.

DiscussionComment

A comment on a discussion.

DiscussionComment Implements

Fields for DiscussionComment

NameDescription

author (Actor)

The actor who authored the comment.

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

body (String!)

The body as Markdown.

bodyHTML (HTML!)

The body rendered to HTML.

bodyText (String!)

The body rendered to text.

createdAt (DateTime!)

Identifies the date and time when the object was created.

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

databaseId (Int)

Identifies the primary key from the database.

deletedAt (DateTime)

The time when this replied-to comment was deleted.

discussion (Discussion)

The discussion this comment was created in.

editor (Actor)

The actor who edited the comment.

id (ID!)

The Node ID of the DiscussionComment object.

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

isAnswer (Boolean!)

Has this comment been chosen as the answer of its discussion?.

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

lastEditedAt (DateTime)

The moment the editor made the last edit.

minimizedReason (String)

Returns why the comment was minimized. One of abuse, off-topic, outdated, resolved, duplicate and spam. Note that the case and formatting of these values differs from the inputs to the MinimizeComment mutation.

publishedAt (DateTime)

Identifies when the comment was published at.

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

Arguments for reactions

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (ReactionOrder)

    Allows specifying the order in which reactions are returned.

replies (DiscussionCommentConnection!)

The threaded replies to this comment.

Arguments for replies

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

replyTo (DiscussionComment)

The discussion comment this comment is a reply to.

resourcePath (URI!)

The path for this discussion comment.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

upvoteCount (Int!)

Number of upvotes that this subject has received.

url (URI!)

The URL for this discussion comment.

userContentEdits (UserContentEditConnection)

A list of edits to this content.

Arguments for userContentEdits

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

viewerCanMarkAsAnswer (Boolean!)

Can the current user mark this comment as an answer?.

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

viewerCanReact (Boolean!)

Can user react to this subject.

viewerCanUnmarkAsAnswer (Boolean!)

Can the current user unmark this comment as an answer?.

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

viewerCanUpvote (Boolean!)

Whether or not the current user can add or remove an upvote on this subject.

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

viewerHasUpvoted (Boolean!)

Whether or not the current user has already upvoted this subject.

DiscussionCommentConnection

The connection type for DiscussionComment.

Fields for DiscussionCommentConnection

NameDescription

edges ([DiscussionCommentEdge])

A list of edges.

nodes ([DiscussionComment])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

DiscussionCommentEdge

An edge in a connection.

Fields for DiscussionCommentEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (DiscussionComment)

The item at the end of the edge.

DiscussionConnection

The connection type for Discussion.

Fields for DiscussionConnection

NameDescription

edges ([DiscussionEdge])

A list of edges.

nodes ([Discussion])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

DiscussionEdge

An edge in a connection.

Fields for DiscussionEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (Discussion)

The item at the end of the edge.

DiscussionPoll

A poll for a discussion.

DiscussionPoll Implements

Fields for DiscussionPoll

NameDescription

discussion (Discussion)

The discussion that this poll belongs to.

id (ID!)

The Node ID of the DiscussionPoll object.

options (DiscussionPollOptionConnection)

The options for this poll.

Arguments for options

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

question (String!)

The question that is being asked by this poll.

totalVoteCount (Int!)

The total number of votes that have been cast for this poll.

viewerCanVote (Boolean!)

Indicates if the viewer has permission to vote in this poll.

viewerHasVoted (Boolean!)

Indicates if the viewer has voted for any option in this poll.

DiscussionPollOption

An option for a discussion poll.

DiscussionPollOption Implements

Fields for DiscussionPollOption

NameDescription

id (ID!)

The Node ID of the DiscussionPollOption object.

option (String!)

The text for this option.

poll (DiscussionPoll)

The discussion poll that this option belongs to.

totalVoteCount (Int!)

The total number of votes that have been cast for this option.

viewerHasVoted (Boolean!)

Indicates if the viewer has voted for this option in the poll.

DiscussionPollOptionConnection

The connection type for DiscussionPollOption.

Fields for DiscussionPollOptionConnection

NameDescription

edges ([DiscussionPollOptionEdge])

A list of edges.

nodes ([DiscussionPollOption])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

DiscussionPollOptionEdge

An edge in a connection.

Fields for DiscussionPollOptionEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (DiscussionPollOption)

The item at the end of the edge.

DraftIssue

A draft issue within a project.

DraftIssue Implements

Fields for DraftIssue

NameDescription

assignees (UserConnection!)

A list of users to assigned to this draft issue.

Arguments for assignees

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

body (String!)

The body of the draft issue.

bodyHTML (HTML!)

The body of the draft issue rendered to HTML.

bodyText (String!)

The body of the draft issue rendered to text.

createdAt (DateTime!)

Identifies the date and time when the object was created.

creator (Actor)

The actor who created this draft issue.

id (ID!)

The Node ID of the DraftIssue object.

projectV2Items (ProjectV2ItemConnection!)

List of items linked with the draft issue (currently draft issue can be linked to only one item).

Arguments for projectV2Items

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

projectsV2 (ProjectV2Connection!)

Projects that link to this draft issue (currently draft issue can be linked to only one project).

Arguments for projectsV2

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

title (String!)

The title of the draft issue.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

Enterprise

An account to manage multiple organizations with consolidated policy and billing.

Enterprise Implements

Fields for Enterprise

NameDescription

announcement (String)

The text of the announcement.

announcementCreatedAt (DateTime)

The date the announcement was created.

announcementExpiresAt (DateTime)

The expiration date of the announcement, if any.

announcementUserDismissible (Boolean)

Whether the announcement can be dismissed by the user.

avatarUrl (URI!)

A URL pointing to the enterprise's public avatar.

Arguments for avatarUrl

  • size (Int)

    The size of the resulting square image.

billingEmail (String)

The enterprise's billing email.

billingInfo (EnterpriseBillingInfo)

Enterprise billing information visible to enterprise billing managers.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

description (String)

The description of the enterprise.

descriptionHTML (HTML!)

The description of the enterprise as HTML.

id (ID!)

The Node ID of the Enterprise object.

location (String)

The location of the enterprise.

members (EnterpriseMemberConnection!)

A list of users who are members of this enterprise.

Arguments for members

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • hasTwoFactorEnabled (Boolean)

    Only return members with this two-factor authentication status. Does not include members who only have an account on a GitHub Enterprise Server instance.

    Upcoming Change on 2025-04-01 UTC Description: hasTwoFactorEnabled will be removed. Use two_factor_method_security instead. Reason: has_two_factor_enabled will be removed.

  • last (Int)

    Returns the last n elements from the list.

  • organizationLogins ([String!])

    Only return members within the organizations with these logins.

  • query (String)

    The search string to look for.

  • twoFactorMethodSecurity (TwoFactorCredentialSecurityType)

    Only return members with this type of two-factor authentication method. Does not include members who only have an account on a GitHub Enterprise Server instance.

name (String!)

The name of the enterprise.

organizations (OrganizationConnection!)

A list of organizations that belong to this enterprise.

Arguments for organizations

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (OrganizationOrder)

    Ordering options for organizations returned from the connection.

  • query (String)

    The search string to look for.

ownerInfo (EnterpriseOwnerInfo)

Enterprise information visible to enterprise owners or enterprise owners' personal access tokens (classic) with read:enterprise or admin:enterprise scope.

readme (String)

The raw content of the enterprise README.

readmeHTML (HTML!)

The content of the enterprise README as HTML.

resourcePath (URI!)

The HTTP path for this enterprise.

slug (String!)

The URL-friendly identifier for the enterprise.

url (URI!)

The HTTP URL for this enterprise.

viewerIsAdmin (Boolean!)

Is the current viewer an admin of this enterprise?.

websiteUrl (URI)

The URL of the enterprise website.

EnterpriseAdministratorConnection

The connection type for User.

Fields for EnterpriseAdministratorConnection

NameDescription

edges ([EnterpriseAdministratorEdge])

A list of edges.

nodes ([User])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

EnterpriseAdministratorEdge

A User who is an administrator of an enterprise.

Fields for EnterpriseAdministratorEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (User)

The item at the end of the edge.

role (EnterpriseAdministratorRole!)

The role of the administrator.

EnterpriseAdministratorInvitation

An invitation for a user to become an owner or billing manager of an enterprise.

EnterpriseAdministratorInvitation Implements

Fields for EnterpriseAdministratorInvitation

NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

email (String)

The email of the person who was invited to the enterprise.

enterprise (Enterprise!)

The enterprise the invitation is for.

id (ID!)

The Node ID of the EnterpriseAdministratorInvitation object.

invitee (User)

The user who was invited to the enterprise.

inviter (User)

The user who created the invitation.

role (EnterpriseAdministratorRole!)

The invitee's pending role in the enterprise (owner or billing_manager).

EnterpriseAdministratorInvitationConnection

The connection type for EnterpriseAdministratorInvitation.

Fields for EnterpriseAdministratorInvitationConnection

NameDescription

edges ([EnterpriseAdministratorInvitationEdge])

A list of edges.

nodes ([EnterpriseAdministratorInvitation])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

EnterpriseAdministratorInvitationEdge

An edge in a connection.

Fields for EnterpriseAdministratorInvitationEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (EnterpriseAdministratorInvitation)

The item at the end of the edge.

EnterpriseBillingInfo

Enterprise billing information visible to enterprise billing managers and owners.

Fields for EnterpriseBillingInfo

NameDescription

allLicensableUsersCount (Int!)

The number of licenseable users/emails across the enterprise.

assetPacks (Int!)

The number of data packs used by all organizations owned by the enterprise.

bandwidthQuota (Float!)

The bandwidth quota in GB for all organizations owned by the enterprise.

bandwidthUsage (Float!)

The bandwidth usage in GB for all organizations owned by the enterprise.

bandwidthUsagePercentage (Int!)

The bandwidth usage as a percentage of the bandwidth quota.

storageQuota (Float!)

The storage quota in GB for all organizations owned by the enterprise.

storageUsage (Float!)

The storage usage in GB for all organizations owned by the enterprise.

storageUsagePercentage (Int!)

The storage usage as a percentage of the storage quota.

totalAvailableLicenses (Int!)

The number of available licenses across all owned organizations based on the unique number of billable users.

totalLicenses (Int!)

The total number of licenses allocated.

EnterpriseConnection

The connection type for Enterprise.

Fields for EnterpriseConnection

NameDescription

edges ([EnterpriseEdge])

A list of edges.

nodes ([Enterprise])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

EnterpriseEdge

An edge in a connection.

Fields for EnterpriseEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (Enterprise)

The item at the end of the edge.

EnterpriseFailedInvitationConnection

The connection type for OrganizationInvitation.

Fields for EnterpriseFailedInvitationConnection

NameDescription

edges ([EnterpriseFailedInvitationEdge])

A list of edges.

nodes ([OrganizationInvitation])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

totalUniqueUserCount (Int!)

Identifies the total count of unique users in the connection.

EnterpriseFailedInvitationEdge

A failed invitation to be a member in an enterprise organization.

Fields for EnterpriseFailedInvitationEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (OrganizationInvitation)

The item at the end of the edge.

EnterpriseIdentityProvider

An identity provider configured to provision identities for an enterprise. Visible to enterprise owners or enterprise owners' personal access tokens (classic) with read:enterprise or admin:enterprise scope.

EnterpriseIdentityProvider Implements

Fields for EnterpriseIdentityProvider

NameDescription

digestMethod (SamlDigestAlgorithm)

The digest algorithm used to sign SAML requests for the identity provider.

enterprise (Enterprise)

The enterprise this identity provider belongs to.

externalIdentities (ExternalIdentityConnection!)

ExternalIdentities provisioned by this identity provider.

Arguments for externalIdentities

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • login (String)

    Filter to external identities with the users login.

  • membersOnly (Boolean)

    Filter to external identities with valid org membership only.

  • userName (String)

    Filter to external identities with the users userName/NameID attribute.

id (ID!)

The Node ID of the EnterpriseIdentityProvider object.

idpCertificate (X509Certificate)

The x509 certificate used by the identity provider to sign assertions and responses.

issuer (String)

The Issuer Entity ID for the SAML identity provider.

recoveryCodes ([String!])

Recovery codes that can be used by admins to access the enterprise if the identity provider is unavailable.

signatureMethod (SamlSignatureAlgorithm)

The signature algorithm used to sign SAML requests for the identity provider.

ssoUrl (URI)

The URL endpoint for the identity provider's SAML SSO.

EnterpriseMemberConnection

The connection type for EnterpriseMember.

Fields for EnterpriseMemberConnection

NameDescription

edges ([EnterpriseMemberEdge])

A list of edges.

nodes ([EnterpriseMember])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

EnterpriseMemberEdge

A User who is a member of an enterprise through one or more organizations.

Fields for EnterpriseMemberEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (EnterpriseMember)

The item at the end of the edge.

EnterpriseMemberInvitation

An invitation for a user to become an unaffiliated member of an enterprise.

EnterpriseMemberInvitation Implements

Fields for EnterpriseMemberInvitation

NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

email (String)

The email of the person who was invited to the enterprise.

enterprise (Enterprise!)

The enterprise the invitation is for.

id (ID!)

The Node ID of the EnterpriseMemberInvitation object.

invitee (User)

The user who was invited to the enterprise.

inviter (User)

The user who created the invitation.

EnterpriseMemberInvitationConnection

The connection type for EnterpriseMemberInvitation.

Fields for EnterpriseMemberInvitationConnection

NameDescription

edges ([EnterpriseMemberInvitationEdge])

A list of edges.

nodes ([EnterpriseMemberInvitation])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

EnterpriseMemberInvitationEdge

An edge in a connection.

Fields for EnterpriseMemberInvitationEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (EnterpriseMemberInvitation)

The item at the end of the edge.

EnterpriseOrganizationMembershipConnection

The connection type for Organization.

Fields for EnterpriseOrganizationMembershipConnection

NameDescription

edges ([EnterpriseOrganizationMembershipEdge])

A list of edges.

nodes ([Organization])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

EnterpriseOrganizationMembershipEdge

An enterprise organization that a user is a member of.

Fields for EnterpriseOrganizationMembershipEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (Organization)

The item at the end of the edge.

role (EnterpriseUserAccountMembershipRole!)

The role of the user in the enterprise membership.

EnterpriseOutsideCollaboratorConnection

The connection type for User.

Fields for EnterpriseOutsideCollaboratorConnection

NameDescription

edges ([EnterpriseOutsideCollaboratorEdge])

A list of edges.

nodes ([User])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

EnterpriseOutsideCollaboratorEdge

A User who is an outside collaborator of an enterprise through one or more organizations.

Fields for EnterpriseOutsideCollaboratorEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (User)

The item at the end of the edge.

repositories (EnterpriseRepositoryInfoConnection!)

The enterprise organization repositories this user is a member of.

Arguments for repositories

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

EnterpriseOwnerInfo

Enterprise information visible to enterprise owners or enterprise owners' personal access tokens (classic) with read:enterprise or admin:enterprise scope.

Fields for EnterpriseOwnerInfo

NameDescription

admins (EnterpriseAdministratorConnection!)

A list of all of the administrators for this enterprise.

Arguments for admins

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • hasTwoFactorEnabled (Boolean)

    Only return administrators with this two-factor authentication status.

    Upcoming Change on 2025-04-01 UTC Description: hasTwoFactorEnabled will be removed. Use two_factor_method_security instead. Reason: has_two_factor_enabled will be removed.

  • last (Int)

    Returns the last n elements from the list.

  • organizationLogins ([String!])

    Only return members within the organizations with these logins.

  • query (String)

    The search string to look for.

affiliatedUsersWithTwoFactorDisabled (UserConnection!)

A list of users in the enterprise who currently have two-factor authentication disabled.

Arguments for affiliatedUsersWithTwoFactorDisabled

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

affiliatedUsersWithTwoFactorDisabledExist (Boolean!)

Whether or not affiliated users with two-factor authentication disabled exist in the enterprise.

allowPrivateRepositoryForkingSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether private repository forking is enabled for repositories in organizations in this enterprise.

allowPrivateRepositoryForkingSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided private repository forking setting value.

Arguments for allowPrivateRepositoryForkingSettingOrganizations

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • value (Boolean!)

    The setting value to find organizations for.

allowPrivateRepositoryForkingSettingPolicyValue (EnterpriseAllowPrivateRepositoryForkingPolicyValue)

The value for the allow private repository forking policy on the enterprise.

defaultRepositoryPermissionSetting (EnterpriseDefaultRepositoryPermissionSettingValue!)

The setting value for base repository permissions for organizations in this enterprise.

defaultRepositoryPermissionSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided base repository permission.

Arguments for defaultRepositoryPermissionSettingOrganizations

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

domains (VerifiableDomainConnection!)

A list of domains owned by the enterprise. Visible to enterprise owners or enterprise owners' personal access tokens (classic) with admin:enterprise scope.

Arguments for domains

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • isApproved (Boolean)

    Filter whether or not the domain is approved.

  • isVerified (Boolean)

    Filter whether or not the domain is verified.

  • last (Int)

    Returns the last n elements from the list.

enterpriseServerInstallations (EnterpriseServerInstallationConnection!)

Enterprise Server installations owned by the enterprise.

Arguments for enterpriseServerInstallations

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • connectedOnly (Boolean)

    Whether or not to only return installations discovered via GitHub Connect.

    The default value is false.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

failedInvitations (EnterpriseFailedInvitationConnection!)

A list of failed invitations in the enterprise.

Arguments for failedInvitations

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • query (String)

    The search string to look for.

ipAllowListEnabledSetting (IpAllowListEnabledSettingValue!)

The setting value for whether the enterprise has an IP allow list enabled.

ipAllowListEntries (IpAllowListEntryConnection!)

The IP addresses that are allowed to access resources owned by the enterprise. Visible to enterprise owners or enterprise owners' personal access tokens (classic) with admin:enterprise scope.

Arguments for ipAllowListEntries

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

ipAllowListForInstalledAppsEnabledSetting (IpAllowListForInstalledAppsEnabledSettingValue!)

The setting value for whether the enterprise has IP allow list configuration for installed GitHub Apps enabled.

isUpdatingDefaultRepositoryPermission (Boolean!)

Whether or not the base repository permission is currently being updated.

isUpdatingTwoFactorRequirement (Boolean!)

Whether the two-factor authentication requirement is currently being enforced.

membersCanChangeRepositoryVisibilitySetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether organization members with admin permissions on a repository can change repository visibility.

membersCanChangeRepositoryVisibilitySettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided can change repository visibility setting value.

Arguments for membersCanChangeRepositoryVisibilitySettingOrganizations

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • value (Boolean!)

    The setting value to find organizations for.

membersCanCreateInternalRepositoriesSetting (Boolean)

The setting value for whether members of organizations in the enterprise can create internal repositories.

membersCanCreatePrivateRepositoriesSetting (Boolean)

The setting value for whether members of organizations in the enterprise can create private repositories.

membersCanCreatePublicRepositoriesSetting (Boolean)

The setting value for whether members of organizations in the enterprise can create public repositories.

membersCanCreateRepositoriesSetting (EnterpriseMembersCanCreateRepositoriesSettingValue)

The setting value for whether members of organizations in the enterprise can create repositories.

membersCanCreateRepositoriesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided repository creation setting value.

Arguments for membersCanCreateRepositoriesSettingOrganizations

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

membersCanDeleteIssuesSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members with admin permissions for repositories can delete issues.

membersCanDeleteIssuesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can delete issues setting value.

Arguments for membersCanDeleteIssuesSettingOrganizations

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • value (Boolean!)

    The setting value to find organizations for.

membersCanDeleteRepositoriesSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members with admin permissions for repositories can delete or transfer repositories.

membersCanDeleteRepositoriesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can delete repositories setting value.

Arguments for membersCanDeleteRepositoriesSettingOrganizations

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • value (Boolean!)

    The setting value to find organizations for.

membersCanInviteCollaboratorsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members of organizations in the enterprise can invite outside collaborators.

membersCanInviteCollaboratorsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can invite collaborators setting value.

Arguments for membersCanInviteCollaboratorsSettingOrganizations

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • value (Boolean!)

    The setting value to find organizations for.

membersCanMakePurchasesSetting (EnterpriseMembersCanMakePurchasesSettingValue!)

Indicates whether members of this enterprise's organizations can purchase additional services for those organizations.

membersCanUpdateProtectedBranchesSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members with admin permissions for repositories can update protected branches.

membersCanUpdateProtectedBranchesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can update protected branches setting value.

Arguments for membersCanUpdateProtectedBranchesSettingOrganizations

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • value (Boolean!)

    The setting value to find organizations for.

membersCanViewDependencyInsightsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members can view dependency insights.

membersCanViewDependencyInsightsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can view dependency insights setting value.

Arguments for membersCanViewDependencyInsightsSettingOrganizations

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • value (Boolean!)

    The setting value to find organizations for.

notificationDeliveryRestrictionEnabledSetting (NotificationRestrictionSettingValue!)

Indicates if email notification delivery for this enterprise is restricted to verified or approved domains.

oidcProvider (OIDCProvider)

The OIDC Identity Provider for the enterprise.

organizationProjectsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether organization projects are enabled for organizations in this enterprise.

organizationProjectsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided organization projects setting value.

Arguments for organizationProjectsSettingOrganizations

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • value (Boolean!)

    The setting value to find organizations for.

outsideCollaborators (EnterpriseOutsideCollaboratorConnection!)

A list of outside collaborators across the repositories in the enterprise.

Arguments for outsideCollaborators

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • hasTwoFactorEnabled (Boolean)

    Only return outside collaborators with this two-factor authentication status.

    Upcoming Change on 2025-04-01 UTC Description: hasTwoFactorEnabled will be removed. Use two_factor_method_security instead. Reason: has_two_factor_enabled will be removed.

  • last (Int)

    Returns the last n elements from the list.

  • login (String)

    The login of one specific outside collaborator.

  • organizationLogins ([String!])

    Only return outside collaborators within the organizations with these logins.

  • query (String)

    The search string to look for.

  • visibility (RepositoryVisibility)

    Only return outside collaborators on repositories with this visibility.

pendingAdminInvitations (EnterpriseAdministratorInvitationConnection!)

A list of pending administrator invitations for the enterprise.

Arguments for pendingAdminInvitations

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • query (String)

    The search string to look for.

pendingCollaboratorInvitations (RepositoryInvitationConnection!)

A list of pending collaborator invitations across the repositories in the enterprise.

Arguments for pendingCollaboratorInvitations

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (RepositoryInvitationOrder)

    Ordering options for pending repository collaborator invitations returned from the connection.

  • query (String)

    The search string to look for.

pendingMemberInvitations (EnterprisePendingMemberInvitationConnection!)

A list of pending member invitations for organizations in the enterprise.

Arguments for pendingMemberInvitations

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • organizationLogins ([String!])

    Only return invitations within the organizations with these logins.

  • query (String)

    The search string to look for.

pendingUnaffiliatedMemberInvitations (EnterpriseMemberInvitationConnection!)

A list of pending unaffiliated member invitations for the enterprise.

Arguments for pendingUnaffiliatedMemberInvitations

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • query (String)

    The search string to look for.

repositoryProjectsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether repository projects are enabled in this enterprise.

repositoryProjectsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided repository projects setting value.

Arguments for repositoryProjectsSettingOrganizations

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • value (Boolean!)

    The setting value to find organizations for.

samlIdentityProvider (EnterpriseIdentityProvider)

The SAML Identity Provider for the enterprise.

samlIdentityProviderSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the SAML single sign-on setting value.

Arguments for samlIdentityProviderSettingOrganizations

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

supportEntitlements (EnterpriseMemberConnection!)

A list of members with a support entitlement.

Arguments for supportEntitlements

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (EnterpriseMemberOrder)

    Ordering options for support entitlement users returned from the connection.

teamDiscussionsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether team discussions are enabled for organizations in this enterprise.

teamDiscussionsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided team discussions setting value.

Arguments for teamDiscussionsSettingOrganizations

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • value (Boolean!)

    The setting value to find organizations for.

twoFactorDisallowedMethodsSetting (EnterpriseDisallowedMethodsSettingValue!)

The setting value for what methods of two-factor authentication the enterprise prevents its users from having.

twoFactorRequiredSetting (EnterpriseEnabledSettingValue!)

The setting value for whether the enterprise requires two-factor authentication for its organizations and users.

twoFactorRequiredSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the two-factor authentication setting value.

Arguments for twoFactorRequiredSettingOrganizations

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • value (Boolean!)

    The setting value to find organizations for.

EnterprisePendingMemberInvitationConnection

The connection type for OrganizationInvitation.

Fields for EnterprisePendingMemberInvitationConnection

NameDescription

edges ([EnterprisePendingMemberInvitationEdge])

A list of edges.

nodes ([OrganizationInvitation])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

totalUniqueUserCount (Int!)

Identifies the total count of unique users in the connection.

EnterprisePendingMemberInvitationEdge

An invitation to be a member in an enterprise organization.

Fields for EnterprisePendingMemberInvitationEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (OrganizationInvitation)

The item at the end of the edge.

EnterpriseRepositoryInfo

A subset of repository information queryable from an enterprise.

EnterpriseRepositoryInfo Implements

Fields for EnterpriseRepositoryInfo

NameDescription

id (ID!)

The Node ID of the EnterpriseRepositoryInfo object.

isPrivate (Boolean!)

Identifies if the repository is private or internal.

name (String!)

The repository's name.

nameWithOwner (String!)

The repository's name with owner.

EnterpriseRepositoryInfoConnection

The connection type for EnterpriseRepositoryInfo.

Fields for EnterpriseRepositoryInfoConnection

NameDescription

edges ([EnterpriseRepositoryInfoEdge])

A list of edges.

nodes ([EnterpriseRepositoryInfo])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

EnterpriseRepositoryInfoEdge

An edge in a connection.

Fields for EnterpriseRepositoryInfoEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (EnterpriseRepositoryInfo)

The item at the end of the edge.

EnterpriseServerInstallation

An Enterprise Server installation.

EnterpriseServerInstallation Implements

Fields for EnterpriseServerInstallation

NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

customerName (String!)

The customer name to which the Enterprise Server installation belongs.

hostName (String!)

The host name of the Enterprise Server installation.

id (ID!)

The Node ID of the EnterpriseServerInstallation object.

isConnected (Boolean!)

Whether or not the installation is connected to an Enterprise Server installation via GitHub Connect.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

userAccounts (EnterpriseServerUserAccountConnection!)

User accounts on this Enterprise Server installation.

Arguments for userAccounts

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

userAccountsUploads (EnterpriseServerUserAccountsUploadConnection!)

User accounts uploads for the Enterprise Server installation.

Arguments for userAccountsUploads

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

EnterpriseServerInstallationConnection

The connection type for EnterpriseServerInstallation.

Fields for EnterpriseServerInstallationConnection

NameDescription

edges ([EnterpriseServerInstallationEdge])

A list of edges.

nodes ([EnterpriseServerInstallation])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

EnterpriseServerInstallationEdge

An edge in a connection.

Fields for EnterpriseServerInstallationEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (EnterpriseServerInstallation)

The item at the end of the edge.

EnterpriseServerInstallationMembershipConnection

The connection type for EnterpriseServerInstallation.

Fields for EnterpriseServerInstallationMembershipConnection

NameDescription

edges ([EnterpriseServerInstallationMembershipEdge])

A list of edges.

nodes ([EnterpriseServerInstallation])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

EnterpriseServerInstallationMembershipEdge

An Enterprise Server installation that a user is a member of.

Fields for EnterpriseServerInstallationMembershipEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (EnterpriseServerInstallation)

The item at the end of the edge.

role (EnterpriseUserAccountMembershipRole!)

The role of the user in the enterprise membership.

EnterpriseServerUserAccount

A user account on an Enterprise Server installation.

EnterpriseServerUserAccount Implements

Fields for EnterpriseServerUserAccount

NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

emails (EnterpriseServerUserAccountEmailConnection!)

User emails belonging to this user account.

Arguments for emails

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

enterpriseServerInstallation (EnterpriseServerInstallation!)

The Enterprise Server installation on which this user account exists.

id (ID!)

The Node ID of the EnterpriseServerUserAccount object.

isSiteAdmin (Boolean!)

Whether the user account is a site administrator on the Enterprise Server installation.

login (String!)

The login of the user account on the Enterprise Server installation.

profileName (String)

The profile name of the user account on the Enterprise Server installation.

remoteCreatedAt (DateTime!)

The date and time when the user account was created on the Enterprise Server installation.

remoteUserId (Int!)

The ID of the user account on the Enterprise Server installation.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

EnterpriseServerUserAccountConnection

The connection type for EnterpriseServerUserAccount.

Fields for EnterpriseServerUserAccountConnection

NameDescription

edges ([EnterpriseServerUserAccountEdge])

A list of edges.

nodes ([EnterpriseServerUserAccount])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

EnterpriseServerUserAccountEdge

An edge in a connection.

Fields for EnterpriseServerUserAccountEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (EnterpriseServerUserAccount)

The item at the end of the edge.

EnterpriseServerUserAccountEmail

An email belonging to a user account on an Enterprise Server installation.

EnterpriseServerUserAccountEmail Implements

Fields for EnterpriseServerUserAccountEmail

NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

email (String!)

The email address.

id (ID!)

The Node ID of the EnterpriseServerUserAccountEmail object.

isPrimary (Boolean!)

Indicates whether this is the primary email of the associated user account.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

userAccount (EnterpriseServerUserAccount!)

The user account to which the email belongs.

EnterpriseServerUserAccountEmailConnection

The connection type for EnterpriseServerUserAccountEmail.

Fields for EnterpriseServerUserAccountEmailConnection

NameDescription

edges ([EnterpriseServerUserAccountEmailEdge])

A list of edges.

nodes ([EnterpriseServerUserAccountEmail])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

EnterpriseServerUserAccountEmailEdge

An edge in a connection.

Fields for EnterpriseServerUserAccountEmailEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (EnterpriseServerUserAccountEmail)

The item at the end of the edge.

EnterpriseServerUserAccountsUpload

A user accounts upload from an Enterprise Server installation.

EnterpriseServerUserAccountsUpload Implements

Fields for EnterpriseServerUserAccountsUpload

NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

enterprise (Enterprise!)

The enterprise to which this upload belongs.

enterpriseServerInstallation (EnterpriseServerInstallation!)

The Enterprise Server installation for which this upload was generated.

id (ID!)

The Node ID of the EnterpriseServerUserAccountsUpload object.

name (String!)

The name of the file uploaded.

syncState (EnterpriseServerUserAccountsUploadSyncState!)

The synchronization state of the upload.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

EnterpriseServerUserAccountsUploadConnection

The connection type for EnterpriseServerUserAccountsUpload.

Fields for EnterpriseServerUserAccountsUploadConnection

NameDescription

edges ([EnterpriseServerUserAccountsUploadEdge])

A list of edges.

nodes ([EnterpriseServerUserAccountsUpload])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

EnterpriseServerUserAccountsUploadEdge

An edge in a connection.

Fields for EnterpriseServerUserAccountsUploadEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (EnterpriseServerUserAccountsUpload)

The item at the end of the edge.

EnterpriseUserAccount

An account for a user who is an admin of an enterprise or a member of an enterprise through one or more organizations.

EnterpriseUserAccount Implements

Fields for EnterpriseUserAccount

NameDescription

avatarUrl (URI!)

A URL pointing to the enterprise user account's public avatar.

Arguments for avatarUrl

  • size (Int)

    The size of the resulting square image.

createdAt (DateTime!)

Identifies the date and time when the object was created.

enterprise (Enterprise!)

The enterprise in which this user account exists.

enterpriseInstallations (EnterpriseServerInstallationMembershipConnection!)

A list of Enterprise Server installations this user is a member of.

Arguments for enterpriseInstallations

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • query (String)

    The search string to look for.

id (ID!)

The Node ID of the EnterpriseUserAccount object.

login (String!)

An identifier for the enterprise user account, a login or email address.

name (String)

The name of the enterprise user account.

organizations (EnterpriseOrganizationMembershipConnection!)

A list of enterprise organizations this user is a member of.

Arguments for organizations

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (OrganizationOrder)

    Ordering options for organizations returned from the connection.

  • query (String)

    The search string to look for.

resourcePath (URI!)

The HTTP path for this user.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL for this user.

user (User)

The user within the enterprise.

Environment

An environment.

Environment Implements

Fields for Environment

NameDescription

databaseId (Int)

Identifies the primary key from the database.

id (ID!)

The Node ID of the Environment object.

isPinned (Boolean)

Indicates whether or not this environment is currently pinned to the repository.

latestCompletedDeployment (Deployment)

The latest completed deployment with status success, failure, or error if it exists.

name (String!)

The name of the environment.

pinnedPosition (Int)

The position of the environment if it is pinned, null if it is not pinned.

protectionRules (DeploymentProtectionRuleConnection!)

The protection rules defined for this environment.

Arguments for protectionRules

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

EnvironmentConnection

The connection type for Environment.

Fields for EnvironmentConnection

NameDescription

edges ([EnvironmentEdge])

A list of edges.

nodes ([Environment])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

EnvironmentEdge

An edge in a connection.

Fields for EnvironmentEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (Environment)

The item at the end of the edge.

ExternalIdentity

An external identity provisioned by SAML SSO or SCIM. If SAML is configured on the organization, the external identity is visible to (1) organization owners, (2) organization owners' personal access tokens (classic) with read:org or admin:org scope, (3) GitHub App with an installation token with read or write access to members. If SAML is configured on the enterprise, the external identity is visible to (1) enterprise owners, (2) enterprise owners' personal access tokens (classic) with read:enterprise or admin:enterprise scope.

ExternalIdentity Implements

Fields for ExternalIdentity

NameDescription

guid (String!)

The GUID for this identity.

id (ID!)

The Node ID of the ExternalIdentity object.

organizationInvitation (OrganizationInvitation)

Organization invitation for this SCIM-provisioned external identity.

samlIdentity (ExternalIdentitySamlAttributes)

SAML Identity attributes.

scimIdentity (ExternalIdentityScimAttributes)

SCIM Identity attributes.

user (User)

User linked to this external identity. Will be NULL if this identity has not been claimed by an organization member.

ExternalIdentityAttribute

An attribute for the External Identity attributes collection.

Fields for ExternalIdentityAttribute

NameDescription

metadata (String)

The attribute metadata as JSON.

name (String!)

The attribute name.

value (String!)

The attribute value.

ExternalIdentityConnection

The connection type for ExternalIdentity.

Fields for ExternalIdentityConnection

NameDescription

edges ([ExternalIdentityEdge])

A list of edges.

nodes ([ExternalIdentity])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

ExternalIdentityEdge

An edge in a connection.

Fields for ExternalIdentityEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (ExternalIdentity)

The item at the end of the edge.

ExternalIdentitySamlAttributes

SAML attributes for the External Identity.

Fields for ExternalIdentitySamlAttributes

NameDescription

attributes ([ExternalIdentityAttribute!]!)

SAML Identity attributes.

emails ([UserEmailMetadata!])

The emails associated with the SAML identity.

familyName (String)

Family name of the SAML identity.

givenName (String)

Given name of the SAML identity.

groups ([String!])

The groups linked to this identity in IDP.

nameId (String)

The NameID of the SAML identity.

username (String)

The userName of the SAML identity.

ExternalIdentityScimAttributes

SCIM attributes for the External Identity.

Fields for ExternalIdentityScimAttributes

NameDescription

emails ([UserEmailMetadata!])

The emails associated with the SCIM identity.

familyName (String)

Family name of the SCIM identity.

givenName (String)

Given name of the SCIM identity.

groups ([String!])

The groups linked to this identity in IDP.

username (String)

The userName of the SCIM identity.

FileExtensionRestrictionParameters

Prevent commits that include files with specified file extensions from being pushed to the commit graph.

Fields for FileExtensionRestrictionParameters

NameDescription

restrictedFileExtensions ([String!]!)

The file extensions that are restricted from being pushed to the commit graph.

FilePathRestrictionParameters

Prevent commits that include changes in specified file paths from being pushed to the commit graph.

Fields for FilePathRestrictionParameters

NameDescription

restrictedFilePaths ([String!]!)

The file paths that are restricted from being pushed to the commit graph.

FollowerConnection

The connection type for User.

Fields for FollowerConnection

NameDescription

edges ([UserEdge])

A list of edges.

nodes ([User])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

FollowingConnection

The connection type for User.

Fields for FollowingConnection

NameDescription

edges ([UserEdge])

A list of edges.

nodes ([User])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

A funding platform link for a repository.

Fields for FundingLink

NameDescription

platform (FundingPlatform!)

The funding platform this link is for.

url (URI!)

The configured URL for this funding link.

GenericHovercardContext

A generic hovercard context with a message and icon.

GenericHovercardContext Implements

Fields for GenericHovercardContext

NameDescription

message (String!)

A string describing this context.

octicon (String!)

An octicon to accompany this context.

Gist

A Gist.

Gist Implements

Fields for Gist

NameDescription

comments (GistCommentConnection!)

A list of comments associated with the gist.

Arguments for comments

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

createdAt (DateTime!)

Identifies the date and time when the object was created.

description (String)

The gist description.

files ([GistFile])

The files in this gist.

Arguments for files

  • limit (Int)

    The maximum number of files to return.

    The default value is 10.

forks (GistConnection!)

A list of forks associated with the gist.

Arguments for forks

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (GistOrder)

    Ordering options for gists returned from the connection.

id (ID!)

The Node ID of the Gist object.

isFork (Boolean!)

Identifies if the gist is a fork.

isPublic (Boolean!)

Whether the gist is public or not.

name (String!)

The gist name.

owner (RepositoryOwner)

The gist owner.

pushedAt (DateTime)

Identifies when the gist was last pushed to.

resourcePath (URI!)

The HTML path to this resource.

stargazerCount (Int!)

Returns a count of how many stargazers there are on this object.

stargazers (StargazerConnection!)

A list of users who have starred this starrable.

Arguments for stargazers

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL for this Gist.

viewerHasStarred (Boolean!)

Returns a boolean indicating whether the viewing user has starred this starrable.

GistComment

Represents a comment on an Gist.

GistComment Implements

Fields for GistComment

NameDescription

author (Actor)

The actor who authored the comment.

authorAssociation (CommentAuthorAssociation!)

Author's association with the gist.

body (String!)

Identifies the comment body.

bodyHTML (HTML!)

The body rendered to HTML.

bodyText (String!)

The body rendered to text.

createdAt (DateTime!)

Identifies the date and time when the object was created.

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

databaseId (Int)

Identifies the primary key from the database.

editor (Actor)

The actor who edited the comment.

gist (Gist!)

The associated gist.

id (ID!)

The Node ID of the GistComment object.

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

lastEditedAt (DateTime)

The moment the editor made the last edit.

minimizedReason (String)

Returns why the comment was minimized. One of abuse, off-topic, outdated, resolved, duplicate and spam. Note that the case and formatting of these values differs from the inputs to the MinimizeComment mutation.

publishedAt (DateTime)

Identifies when the comment was published at.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

userContentEdits (UserContentEditConnection)

A list of edits to this content.

Arguments for userContentEdits

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

GistCommentConnection

The connection type for GistComment.

Fields for GistCommentConnection

NameDescription

edges ([GistCommentEdge])

A list of edges.

nodes ([GistComment])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

GistCommentEdge

An edge in a connection.

Fields for GistCommentEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (GistComment)

The item at the end of the edge.

GistConnection

The connection type for Gist.

Fields for GistConnection

NameDescription

edges ([GistEdge])

A list of edges.

nodes ([Gist])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

GistEdge

An edge in a connection.

Fields for GistEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (Gist)

The item at the end of the edge.

GistFile

A file in a gist.

Fields for GistFile

NameDescription

encodedName (String)

The file name encoded to remove characters that are invalid in URL paths.

encoding (String)

The gist file encoding.

extension (String)

The file extension from the file name.

isImage (Boolean!)

Indicates if this file is an image.

isTruncated (Boolean!)

Whether the file's contents were truncated.

language (Language)

The programming language this file is written in.

name (String)

The gist file name.

size (Int)

The gist file size in bytes.

text (String)

UTF8 text data or null if the file is binary.

Arguments for text

  • truncate (Int)

    Optionally truncate the returned file to this length.

GitActor

Represents an actor in a Git commit (ie. an author or committer).

Fields for GitActor

NameDescription

avatarUrl (URI!)

A URL pointing to the author's public avatar.

Arguments for avatarUrl

  • size (Int)

    The size of the resulting square image.

date (GitTimestamp)

The timestamp of the Git action (authoring or committing).

email (String)

The email in the Git commit.

name (String)

The name in the Git commit.

user (User)

The GitHub user corresponding to the email field. Null if no such user exists.

GitActorConnection

The connection type for GitActor.

Fields for GitActorConnection

NameDescription

edges ([GitActorEdge])

A list of edges.

nodes ([GitActor])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

GitActorEdge

An edge in a connection.

Fields for GitActorEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (GitActor)

The item at the end of the edge.

GitHubMetadata

Represents information about the GitHub instance.

Fields for GitHubMetadata

NameDescription

gitHubServicesSha (GitObjectID!)

Returns a String that's a SHA of github-services.

gitIpAddresses ([String!])

IP addresses that users connect to for git operations.

githubEnterpriseImporterIpAddresses ([String!])

IP addresses that GitHub Enterprise Importer uses for outbound connections.

hookIpAddresses ([String!])

IP addresses that service hooks are sent from.

importerIpAddresses ([String!])

IP addresses that the importer connects from.

isPasswordAuthenticationVerifiable (Boolean!)

Whether or not users are verified.

pagesIpAddresses ([String!])

IP addresses for GitHub Pages' A records.

GpgSignature

Represents a GPG signature on a Commit or Tag.

GpgSignature Implements

Fields for GpgSignature

NameDescription

email (String!)

Email used to sign this object.

isValid (Boolean!)

True if the signature is valid and verified by GitHub.

keyId (String)

Hex-encoded ID of the key that signed this object.

payload (String!)

Payload for GPG signing object. Raw ODB object without the signature header.

signature (String!)

ASCII-armored signature header from object.

signer (User)

GitHub user corresponding to the email signing this commit.

state (GitSignatureState!)

The state of this signature. VALID if signature is valid and verified by GitHub, otherwise represents reason why signature is considered invalid.

wasSignedByGitHub (Boolean!)

True if the signature was made with GitHub's signing key.

HeadRefDeletedEvent

Represents ahead_ref_deletedevent on a given pull request.

HeadRefDeletedEvent Implements

Fields for HeadRefDeletedEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

headRef (Ref)

Identifies the Ref associated with the head_ref_deleted event.

headRefName (String!)

Identifies the name of the Ref associated with the head_ref_deleted event.

id (ID!)

The Node ID of the HeadRefDeletedEvent object.

pullRequest (PullRequest!)

PullRequest referenced by event.

HeadRefForcePushedEvent

Represents ahead_ref_force_pushedevent on a given pull request.

HeadRefForcePushedEvent Implements

Fields for HeadRefForcePushedEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

afterCommit (Commit)

Identifies the after commit SHA for thehead_ref_force_pushedevent.

beforeCommit (Commit)

Identifies the before commit SHA for thehead_ref_force_pushedevent.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the HeadRefForcePushedEvent object.

pullRequest (PullRequest!)

PullRequest referenced by event.

ref (Ref)

Identifies the fully qualified ref name for thehead_ref_force_pushedevent.

HeadRefRestoredEvent

Represents ahead_ref_restoredevent on a given pull request.

HeadRefRestoredEvent Implements

Fields for HeadRefRestoredEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the HeadRefRestoredEvent object.

pullRequest (PullRequest!)

PullRequest referenced by event.

Hovercard

Detail needed to display a hovercard for a user.

Fields for Hovercard

NameDescription

contexts ([HovercardContext!]!)

Each of the contexts for this hovercard.

IpAllowListEntry

An IP address or range of addresses that is allowed to access an owner's resources.

IpAllowListEntry Implements

Fields for IpAllowListEntry

NameDescription

allowListValue (String!)

A single IP address or range of IP addresses in CIDR notation.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the IpAllowListEntry object.

isActive (Boolean!)

Whether the entry is currently active.

name (String)

The name of the IP allow list entry.

owner (IpAllowListOwner!)

The owner of the IP allow list entry.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

IpAllowListEntryConnection

The connection type for IpAllowListEntry.

Fields for IpAllowListEntryConnection

NameDescription

edges ([IpAllowListEntryEdge])

A list of edges.

nodes ([IpAllowListEntry])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

IpAllowListEntryEdge

An edge in a connection.

Fields for IpAllowListEntryEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (IpAllowListEntry)

The item at the end of the edge.

Issue

An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project.

Issue Implements

Fields for Issue

NameDescription

activeLockReason (LockReason)

Reason that the conversation was locked.

assignees (UserConnection!)

A list of Users assigned to this object.

Arguments for assignees

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

author (Actor)

The actor who authored the comment.

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

body (String!)

Identifies the body of the issue.

bodyHTML (HTML!)

The body rendered to HTML.

bodyResourcePath (URI!)

The http path for this issue body.

bodyText (String!)

Identifies the body of the issue rendered to text.

bodyUrl (URI!)

The http URL for this issue body.

closed (Boolean!)

Indicates if the object is closed (definition of closed may depend on type).

closedAt (DateTime)

Identifies the date and time when the object was closed.

closedByPullRequestsReferences (PullRequestConnection)

List of open pull requests referenced from this issue.

Arguments for closedByPullRequestsReferences

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • includeClosedPrs (Boolean)

    Include closed PRs in results.

    The default value is false.

  • last (Int)

    Returns the last n elements from the list.

  • orderByState (Boolean)

    Return results ordered by state.

    The default value is false.

  • userLinkedOnly (Boolean)

    Return only manually linked PRs.

    The default value is false.

comments (IssueCommentConnection!)

A list of comments associated with the Issue.

Arguments for comments

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (IssueCommentOrder)

    Ordering options for issue comments returned from the connection.

createdAt (DateTime!)

Identifies the date and time when the object was created.

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

databaseId (Int)

Identifies the primary key from the database.

editor (Actor)

The actor who edited the comment.

fullDatabaseId (BigInt)

Identifies the primary key from the database as a BigInt.

hovercard (Hovercard!)

The hovercard information for this issue.

Arguments for hovercard

  • includeNotificationContexts (Boolean)

    Whether or not to include notification contexts.

    The default value is true.

id (ID!)

The Node ID of the Issue object.

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

isPinned (Boolean)

Indicates whether or not this issue is currently pinned to the repository issues list.

isReadByViewer (Boolean)

Is this issue read by the viewer.

labels (LabelConnection)

A list of labels associated with the object.

Arguments for labels

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (LabelOrder)

    Ordering options for labels returned from the connection.

lastEditedAt (DateTime)

The moment the editor made the last edit.

linkedBranches (LinkedBranchConnection!)

Branches linked to this issue.

Arguments for linkedBranches

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

locked (Boolean!)

true if the object is locked.

milestone (Milestone)

Identifies the milestone associated with the issue.

number (Int!)

Identifies the issue number.

participants (UserConnection!)

A list of Users that are participating in the Issue conversation.

Arguments for participants

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

projectCards (ProjectCardConnection!)

List of project cards associated with this issue.

Arguments for projectCards

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

projectItems (ProjectV2ItemConnection!)

List of project items associated with this issue.

Arguments for projectItems

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • includeArchived (Boolean)

    Include archived items.

    The default value is true.

  • last (Int)

    Returns the last n elements from the list.

projectV2 (ProjectV2)

Find a project by number.

Arguments for projectV2

  • number (Int!)

    The project number.

projectsV2 (ProjectV2Connection!)

A list of projects under the owner.

Arguments for projectsV2

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • query (String)

    A project to search for under the the owner.

publishedAt (DateTime)

Identifies when the comment was published at.

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

Arguments for reactions

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (ReactionOrder)

    Allows specifying the order in which reactions are returned.

repository (Repository!)

The repository associated with this node.

resourcePath (URI!)

The HTTP path for this issue.

state (IssueState!)

Identifies the state of the issue.

stateReason (IssueStateReason)

Identifies the reason for the issue state.

timeline (IssueTimelineConnection!)

A list of events, comments, commits, etc. associated with the issue.

Warning

timeline is deprecated.

timeline will be removed Use Issue.timelineItems instead. Removal on 2020-10-01 UTC.

Arguments for timeline

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • since (DateTime)

    Allows filtering timeline events by a since timestamp.

timelineItems (IssueTimelineItemsConnection!)

A list of events, comments, commits, etc. associated with the issue.

Arguments for timelineItems

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • since (DateTime)

    Filter timeline items by a since timestamp.

  • skip (Int)

    Skips the first n elements in the list.

title (String!)

Identifies the issue title.

titleHTML (String!)

Identifies the issue title rendered to HTML.

trackedInIssues (IssueConnection!)

A list of issues that track this issue.

Arguments for trackedInIssues

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

trackedIssues (IssueConnection!)

A list of issues tracked inside the current issue.

Arguments for trackedIssues

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

trackedIssuesCount (Int!)

The number of tracked issues for this issue.

Arguments for trackedIssuesCount

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL for this issue.

userContentEdits (UserContentEditConnection)

A list of edits to this content.

Arguments for userContentEdits

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

viewerCanClose (Boolean!)

Indicates if the object can be closed by the viewer.

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

viewerCanLabel (Boolean!)

Indicates if the viewer can edit labels for this object.

viewerCanReact (Boolean!)

Can user react to this subject.

viewerCanReopen (Boolean!)

Indicates if the object can be reopened by the viewer.

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

viewerThreadSubscriptionFormAction (ThreadSubscriptionFormAction)

Identifies the viewer's thread subscription form action.

viewerThreadSubscriptionStatus (ThreadSubscriptionState)

Identifies the viewer's thread subscription status.

IssueComment

Represents a comment on an Issue.

IssueComment Implements

Fields for IssueComment

NameDescription

author (Actor)

The actor who authored the comment.

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

body (String!)

The body as Markdown.

bodyHTML (