Interfaces serve as parent objects from which other objects can inherit.
For example, Lockable is an interface because both Issue and PullRequest objects can be locked. An interface has its own list of named fields that are shared by implementing objects.
For more information, see Introduction to GraphQL.
ActorRepresents an object which can take actions on GitHub. Typically a User or Bot.
Actor is implemented by
Fields for Actor Name Description
avatarUrl (URI!)
A URL pointing to the actor's public avatar.
Arguments for avatarUrl
size (Int)
The size of the resulting square image.
login (String!)
The username of the actor.
resourcePath (URI!)
The HTTP path for this actor.
url (URI!)
The HTTP URL for this actor.
AssignableAn object that can have users assigned to it.
Assignable is implemented by
Fields for Assignable Name Description
assignedActors (AssigneeConnection!)
A list of actors assigned to this object.
Arguments for assignedActors
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.
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.
suggestedActors (AssigneeConnection!)
A list of suggested actors to assign to this object.
Arguments for suggestedActors
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)
If provided, searches users by login or profile name.
An object that can be closed.
Closable is implemented by
Fields for Closable Name Description
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.
viewerCanClose (Boolean!)
Indicates if the object can be closed by the viewer.
viewerCanReopen (Boolean!)
Indicates if the object can be reopened by the viewer.
ContributionRepresents a contribution a user made on GitHub, such as opening an issue.
GitObjectRepresents a Git object.
GitObject is implemented by
Fields for GitObject Name Description
abbreviatedOid (String!)
An abbreviated version of the Git object ID.
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 GitObject object.
oid (GitObjectID!)
The Git object ID.
repository (Repository!)
The Repository the Git object belongs to.
GitSignatureInformation about a signature (GPG or S/MIME) on a Commit or Tag.
GitSignature is implemented by
Fields for GitSignature Name Description
email (String!)
Email used to sign this object.
isValid (Boolean!)
True if the signature is valid and verified by GitHub.
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.
verifiedAt (DateTime)
The date the signature was verified, if valid.
wasSignedByGitHub (Boolean!)
True if the signature was made with GitHub's signing key.
LabelableAn object that can have labels assigned to it.
Labelable is implemented by
Fields for Labelable Name Description
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.
viewerCanLabel (Boolean!)
Indicates if the viewer can edit labels for this object.
MemberStatusableEntities that have members who can set status messages.
MemberStatusable is implemented by
Fields for MemberStatusable Name Description
memberStatuses (UserStatusConnection!)
Get the status messages members of this entity have set that are either public or visible only to the organization.
Arguments for memberStatuses
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 (UserStatusOrder)
Ordering options for user statuses returned from the connection.
Represents a GitHub Enterprise Importer (GEI) migration.
Migration is implemented by
Fields for Migration Name Description
continueOnError (Boolean!)
The migration flag to continue on error.
createdAt (DateTime!)
Identifies the date and time when the object was created.
databaseId (String)
Identifies the primary key from the database.
failureReason (String)
The reason the migration failed.
id (ID!)
The Node ID of the Migration object.
migrationLogUrl (URI)
The URL for the migration log (expires 1 day after migration completes).
migrationSource (MigrationSource!)
The migration source.
repositoryName (String!)
The target repository name.
sourceUrl (URI!)
The migration source URL, for example https://github.com or https://monalisa.ghe.com.
state (MigrationState!)
The migration state.
warningsCount (Int!)
The number of warnings encountered for this migration. To review the warnings, check the Migration Log.
NodeAn object with an ID.
PackageOwnerRepresents an owner of a package.
PackageOwner is implemented by
Fields for PackageOwner Name Description
id (ID!)
The Node ID of the PackageOwner object.
packages (PackageConnection!)
A list of packages under the owner.
Arguments for packages
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.
names ([String])
Find packages by their names.
orderBy (PackageOrder)
Ordering of the returned packages.
packageType (PackageType)
Filter registry package by type.
repositoryId (ID)
Find packages in a repository by ID.
Represents any entity on GitHub that has a profile page.
ProfileOwner is implemented by
Fields for ProfileOwner Name Description
anyPinnableItems (Boolean!)
Determine if this repository owner has any items that can be pinned to their profile.
Arguments for anyPinnableItems
type (PinnableItemType)
Filter to only a particular kind of pinnable item.
email (String)
The public profile email.
id (ID!)
The Node ID of the ProfileOwner object.
itemShowcase (ProfileItemShowcase!)
Showcases a selection of repositories and gists that the profile owner has either curated or that have been selected automatically based on popularity.
location (String)
The public profile location.
login (String!)
The username used to login.
name (String)
The public profile name.
pinnableItems (PinnableItemConnection!)
A list of repositories and gists this profile owner can pin to their profile.
Arguments for pinnableItems
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.
types ([PinnableItemType!])
Filter the types of pinnable items that are returned.
pinnedItems (PinnableItemConnection!)
A list of repositories and gists this profile owner has pinned to their profile.
Arguments for pinnedItems
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.
types ([PinnableItemType!])
Filter the types of pinned items that are returned.
pinnedItemsRemaining (Int!)
Returns how many more items this profile owner can pin to their profile.
viewerCanChangePinnedItems (Boolean!)
Can the viewer pin repositories and gists to the profile?.
websiteUrl (URI)
The public profile website URL.
ProjectV2OwnerRepresents an owner of a project.
ProjectV2Owner is implemented by
Fields for ProjectV2Owner Name Description
id (ID!)
The Node ID of the ProjectV2Owner object.
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.
minPermissionLevel (ProjectV2PermissionLevel)
Filter projects based on user role.
The default value is READ.
orderBy (ProjectV2Order)
How to order the returned projects.
query (String)
A project to search for under the owner.
Recent projects for the owner.
ProjectV2Recent is implemented by
Fields for ProjectV2Recent Name Description
recentProjects (ProjectV2Connection!)
Recent projects that this user has modified in the context of the owner.
Arguments for recentProjects
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.
Represents a subject that can be reacted on.
Represents an author of discussions in repositories.
RepositoryDiscussionAuthor is implemented by
Fields for RepositoryDiscussionAuthor Name Description
repositoryDiscussions (DiscussionConnection!)
Discussions this user has started.
Arguments for repositoryDiscussions
after (String)
Returns the elements in the list that come after the specified cursor.
answered (Boolean)
Filter discussions to only those that have been answered or not. Defaults to including both answered and unanswered discussions.
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 (DiscussionOrder)
Ordering options for discussions returned from the connection.
repositoryId (ID)
Filter discussions to only those in a specific repository.
states ([DiscussionState!])
A list of states to filter the discussions by.
Represents an author of discussion comments in repositories.
RepositoryDiscussionCommentAuthor is implemented by
Fields for RepositoryDiscussionCommentAuthor Name Description
repositoryDiscussionComments (DiscussionCommentConnection!)
Discussion comments this user has authored.
Arguments for repositoryDiscussionComments
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.
onlyAnswers (Boolean)
Filter discussion comments to only those that were marked as the answer.
The default value is false.
repositoryId (ID)
Filter discussion comments to only those in a specific repository.
A subset of repository info.
RepositoryInfo is implemented by
Fields for RepositoryInfo Name Description
archivedAt (DateTime)
Identifies the date and time when the repository was archived.
createdAt (DateTime!)
Identifies the date and time when the object was created.
description (String)
The description of the repository.
descriptionHTML (HTML!)
The description of the repository rendered to HTML.
forkCount (Int!)
Returns how many forks there are of this repository in the whole network.
hasDiscussionsEnabled (Boolean!)
Indicates if the repository has the Discussions feature enabled.
hasIssuesEnabled (Boolean!)
Indicates if the repository has issues feature enabled.
hasProjectsEnabled (Boolean!)
Indicates if the repository has the Projects feature enabled.
hasSponsorshipsEnabled (Boolean!)
Indicates if the repository displays a Sponsor button for financial contributions.
hasWikiEnabled (Boolean!)
Indicates if the repository has wiki feature enabled.
homepageUrl (URI)
The repository's URL.
isArchived (Boolean!)
Indicates if the repository is unmaintained.
isFork (Boolean!)
Identifies if the repository is a fork.
isInOrganization (Boolean!)
Indicates if a repository is either owned by an organization, or is a private fork of an organization repository.
isLocked (Boolean!)
Indicates if the repository has been locked or not.
isMirror (Boolean!)
Identifies if the repository is a mirror.
isPrivate (Boolean!)
Identifies if the repository is private or internal.
isTemplate (Boolean!)
Identifies if the repository is a template that can be used to generate new repositories.
licenseInfo (License)
The license associated with the repository.
lockReason (RepositoryLockReason)
The reason the repository has been locked.
mirrorUrl (URI)
The repository's original mirror URL.
name (String!)
The name of the repository.
nameWithOwner (String!)
The repository's name with owner.
openGraphImageUrl (URI!)
The image used to represent this repository in Open Graph data.
owner (RepositoryOwner!)
The User owner of the repository.
pushedAt (DateTime)
Identifies the date and time when the repository was last pushed to.
resourcePath (URI!)
The HTTP path for this repository.
shortDescriptionHTML (HTML!)
A description of the repository, rendered to HTML without any links in it.
Arguments for shortDescriptionHTML
limit (Int)
How many characters to return.
The default value is 200.
updatedAt (DateTime!)
Identifies the date and time when the object was last updated.
url (URI!)
The HTTP URL for this repository.
usesCustomOpenGraphImage (Boolean!)
Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.
visibility (RepositoryVisibility!)
Indicates the repository's visibility level.
RepositoryOwnerRepresents an owner of a Repository.
RepositoryOwner is implemented by
Fields for RepositoryOwner Name Description
avatarUrl (URI!)
A URL pointing to the owner's public avatar.
Arguments for avatarUrl
size (Int)
The size of the resulting square image.
id (ID!)
The Node ID of the RepositoryOwner object.
login (String!)
The username used to login.
repositories (RepositoryConnection!)
A list of repositories that the user owns.
Arguments for repositories
affiliations ([RepositoryAffiliation])
Array of viewer's affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the current viewer owns.
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.
hasIssuesEnabled (Boolean)
If non-null, filters repositories according to whether they have issues enabled.
isArchived (Boolean)
If non-null, filters repositories according to whether they are archived and not maintained.
isFork (Boolean)
If non-null, filters repositories according to whether they are forks of another repository.
isLocked (Boolean)
If non-null, filters repositories according to whether they have been locked.
last (Int)
Returns the last n elements from the list.
orderBy (RepositoryOrder)
Ordering options for repositories returned from the connection.
ownerAffiliations ([RepositoryAffiliation])
Array of owner's affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the organization or user being viewed owns.
privacy (RepositoryPrivacy)
If non-null, filters repositories according to privacy. Internal repositories are considered private; consider using the visibility argument if only internal repositories are needed. Cannot be combined with the visibility argument.
visibility (RepositoryVisibility)
If non-null, filters repositories according to visibility. Cannot be combined with the privacy argument.
repository (Repository)
Find Repository.
Arguments for repository
followRenames (Boolean)
Follow repository renames. If disabled, a repository referenced by its old name will return an error.
The default value is true.
name (String!)
Name of Repository to find.
resourcePath (URI!)
The HTTP URL for the owner.
url (URI!)
The HTTP URL for the owner.
RequirableByPullRequestRepresents a type that can be required by a pull request for merging.
RequirableByPullRequest is implemented by
Fields for RequirableByPullRequest Name Description
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.
Entities that can sponsor or be sponsored through GitHub Sponsors.
Sponsorable is implemented by
Fields for Sponsorable Name Description
estimatedNextSponsorsPayoutInCents (Int!)
The estimated next GitHub Sponsors payout for this user/organization in cents (USD).
hasSponsorsListing (Boolean!)
True if this user/organization has a GitHub Sponsors listing.
isSponsoredBy (Boolean!)
Whether the given account is sponsoring this user/organization.
Arguments for isSponsoredBy
accountLogin (String!)
The target account's login.
isSponsoringViewer (Boolean!)
True if the viewer is sponsored by this user/organization.
lifetimeReceivedSponsorshipValues (SponsorAndLifetimeValueConnection!)
Calculate how much each sponsor has ever paid total to this maintainer via GitHub Sponsors. Does not include sponsorships paid via Patreon.
Arguments for lifetimeReceivedSponsorshipValues
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 (SponsorAndLifetimeValueOrder)
Ordering options for results returned from the connection.
monthlyEstimatedSponsorsIncomeInCents (Int!)
The estimated monthly GitHub Sponsors income for this user/organization in cents (USD).
sponsoring (SponsorConnection!)
List of users and organizations this entity is sponsoring.
Arguments for sponsoring
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 (SponsorOrder)
Ordering options for the users and organizations returned from the connection.
sponsors (SponsorConnection!)
List of sponsors for this user or organization.
Arguments for sponsors
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 (SponsorOrder)
Ordering options for sponsors returned from the connection.
tierId (ID)
If given, will filter for sponsors at the given tier. Will only return sponsors whose tier the viewer is permitted to see.
sponsorsActivities (SponsorsActivityConnection!)
Events involving this sponsorable, such as new sponsorships.
Arguments for sponsorsActivities
actions ([SponsorsActivityAction!])
Filter activities to only the specified actions.
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.
includeAsSponsor (Boolean)
Whether to include those events where this sponsorable acted as the sponsor. Defaults to only including events where this sponsorable was the recipient of a sponsorship.
The default value is false.
includePrivate (Boolean)
Whether or not to include private activities in the result set. Defaults to including public and private activities.
The default value is true.
last (Int)
Returns the last n elements from the list.
orderBy (SponsorsActivityOrder)
Ordering options for activity returned from the connection.
period (SponsorsActivityPeriod)
Filter activities returned to only those that occurred in the most recent specified time period. Set to ALL to avoid filtering by when the activity occurred. Will be ignored if since or until is given.
The default value is MONTH.
since (DateTime)
Filter activities to those that occurred on or after this time.
until (DateTime)
Filter activities to those that occurred before this time.
sponsorsListing (SponsorsListing)
The GitHub Sponsors listing for this user or organization.
sponsorshipForViewerAsSponsor (Sponsorship)
The sponsorship from the viewer to this user/organization; that is, the sponsorship where you're the sponsor.
Arguments for sponsorshipForViewerAsSponsor
activeOnly (Boolean)
Whether to return the sponsorship only if it's still active. Pass false to get the viewer's sponsorship back even if it has been cancelled.
The default value is true.
sponsorshipForViewerAsSponsorable (Sponsorship)
The sponsorship from this user/organization to the viewer; that is, the sponsorship you're receiving.
Arguments for sponsorshipForViewerAsSponsorable
activeOnly (Boolean)
Whether to return the sponsorship only if it's still active. Pass false to get the sponsorship back even if it has been cancelled.
The default value is true.
sponsorshipNewsletters (SponsorshipNewsletterConnection!)
List of sponsorship updates sent from this sponsorable to sponsors.
Arguments for sponsorshipNewsletters
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 (SponsorshipNewsletterOrder)
Ordering options for sponsorship updates returned from the connection.
sponsorshipsAsMaintainer (SponsorshipConnection!)
The sponsorships where this user or organization is the maintainer receiving the funds.
Arguments for sponsorshipsAsMaintainer
activeOnly (Boolean)
Whether to include only sponsorships that are active right now, versus all sponsorships this maintainer has ever received.
The default value is true.
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.
includePrivate (Boolean)
Whether or not to include private sponsorships in the result set.
The default value is false.
last (Int)
Returns the last n elements from the list.
orderBy (SponsorshipOrder)
Ordering options for sponsorships returned from this connection. If left blank, the sponsorships will be ordered based on relevancy to the viewer.
sponsorshipsAsSponsor (SponsorshipConnection!)
The sponsorships where this user or organization is the funder.
Arguments for sponsorshipsAsSponsor
activeOnly (Boolean)
Whether to include only sponsorships that are active right now, versus all sponsorships this sponsor has ever made.
The default value is true.
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.
maintainerLogins ([String!])
Filter sponsorships returned to those for the specified maintainers. That is, the recipient of the sponsorship is a user or organization with one of the given logins.
orderBy (SponsorshipOrder)
Ordering options for sponsorships returned from this connection. If left blank, the sponsorships will be ordered based on relevancy to the viewer.
totalSponsorshipAmountAsSponsorInCents (Int)
The amount in United States cents (e.g., 500 = $5.00 USD) that this entity has spent on GitHub to fund sponsorships. Only returns a value when viewed by the user themselves or by a user who can manage sponsorships for the requested organization.
Arguments for totalSponsorshipAmountAsSponsorInCents
since (DateTime)
Filter payments to those that occurred on or after this time.
sponsorableLogins ([String!])
Filter payments to those made to the users or organizations with the specified usernames.
until (DateTime)
Filter payments to those that occurred before this time.
viewerCanSponsor (Boolean!)
Whether or not the viewer is able to sponsor this user/organization.
viewerIsSponsoring (Boolean!)
True if the viewer is sponsoring this user/organization.
StarrableThings that can be starred.
Starrable is implemented by
Fields for Starrable Name Description
id (ID!)
The Node ID of the Starrable object.
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.
orderBy (StarOrder)
Order for connection.
viewerHasStarred (Boolean!)
Returns a boolean indicating whether the viewing user has starred this starrable.
SubscribableEntities that can be subscribed to for web and email notifications.
SubscribableThreadEntities that can be subscribed to for web and email notifications.
SubscribableThread is implemented by
Fields for SubscribableThread Name Description
id (ID!)
The Node ID of the SubscribableThread object.
viewerThreadSubscriptionFormAction (ThreadSubscriptionFormAction)
Identifies the viewer's thread subscription form action.
viewerThreadSubscriptionStatus (ThreadSubscriptionState)
Identifies the viewer's thread subscription status.
Comments that can be updated.
VotableA subject that may be upvoted.
Votable is implemented by
Fields for Votable Name Description
upvoteCount (Int!)
Number of upvotes that this subject has received.
viewerCanUpvote (Boolean!)
Whether or not the current user can add or remove an upvote on this subject.
viewerHasUpvoted (Boolean!)
Whether or not the current user has already upvoted this subject.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4