Every GraphQL schema has a root type for both queries and mutations. The query type defines GraphQL operations that retrieve data from the server.For GitHub App requests made with user access tokens, you should use separate queries for issues and pull requests. For example, use the is:issue
or is:pull-request
filters and their equivalents. Using the search
connection to return a combination of issues and pull requests in a single query will result in an empty set of nodes.
Look up a code of conduct by its key.Arguments for codeOfConduct
#
Name | Description |
---|
key (String! ) | The code of conduct's key. |
Look up a code of conduct by its key.Look up an enterprise by URL slug.Arguments for enterprise
#
Name | Description |
---|
invitationToken (String ) | The enterprise invitation token. |
slug (String! ) | The enterprise URL slug. |
Look up a pending enterprise administrator invitation by invitee, enterprise and role.Arguments for enterpriseAdministratorInvitation
#
Name | Description |
---|
enterpriseSlug (String! ) | The slug of the enterprise the user was invited to join. |
role (EnterpriseAdministratorRole! ) | The role for the enterprise member invitation. |
userLogin (String! ) | The login of the user invited to join the enterprise. |
Look up a pending enterprise administrator invitation by invitation token.Arguments for enterpriseAdministratorInvitationByToken
#
Name | Description |
---|
invitationToken (String! ) | The invitation token sent with the invitation email. |
Look up a pending enterprise unaffiliated member invitation by invitee and enterprise.Arguments for enterpriseMemberInvitation
#
Name | Description |
---|
enterpriseSlug (String! ) | The slug of the enterprise the user was invited to join. |
userLogin (String! ) | The login of the user invited to join the enterprise. |
Look up a pending enterprise unaffiliated member invitation by invitation token.Arguments for enterpriseMemberInvitationByToken
#
Name | Description |
---|
invitationToken (String! ) | The invitation token sent with the invitation email. |
Look up an open source license by its key.Arguments for license
#
Name | Description |
---|
key (String! ) | The license's downcased SPDX ID. |
Return a list of known open source licenses.Get alphabetically sorted list of Marketplace categories.Arguments for marketplaceCategories
#
Name | Description |
---|
excludeEmpty (Boolean ) | Exclude categories with no listings. |
excludeSubcategories (Boolean ) | Returns top level categories only, excluding any subcategories. |
includeCategories ([String!] ) | Return only the specified categories. |
Look up a Marketplace category by its slug.Arguments for marketplaceCategory
#
Name | Description |
---|
slug (String! ) | The URL slug of the category. |
useTopicAliases (Boolean ) | Also check topic aliases for the category slug. |
Look up a single Marketplace listing.Arguments for marketplaceListing
#
Name | Description |
---|
slug (String! ) | Select the listing that matches this slug. It's the short name of the listing used in its URL. |
Look up Marketplace listings.Arguments for marketplaceListings
#
Name | Description |
---|
adminId (ID ) | Select listings that can be administered by the specified user. |
after (String ) | Returns the elements in the list that come after the specified cursor. |
allStates (Boolean ) | Select listings visible to the viewer even if they are not approved. If omitted or false, only approved listings will be returned. |
before (String ) | Returns the elements in the list that come before the specified cursor. |
categorySlug (String ) | Select only listings with the given category. |
first (Int ) | Returns the first n elements from the list. |
last (Int ) | Returns the last n elements from the list. |
organizationId (ID ) | Select listings for products owned by the specified organization. |
primaryCategoryOnly (Boolean ) | Select only listings where the primary category matches the given category slug.The default value is false . |
slugs ([String] ) | Select the listings with these slugs, if they are visible to the viewer. |
useTopicAliases (Boolean ) | Also check topic aliases for the category slug. |
viewerCanAdmin (Boolean ) | Select listings to which user has admin access. If omitted, listings visible to the viewer are returned. |
withFreeTrialsOnly (Boolean ) | Select only listings that offer a free trial.The default value is false . |
Return information about the GitHub instance.Fetches an object given its ID.Arguments for node
#
Name | Description |
---|
id (ID! ) | ID of the object. |
Lookup nodes by a list of IDs.Arguments for nodes
#
Name | Description |
---|
ids ([ID!]! ) | The list of node IDs. |
Lookup a organization by login.Arguments for organization
#
Name | Description |
---|
login (String! ) | The organization's login. |
The client's rate limit information.Arguments for rateLimit
#
Name | Description |
---|
dryRun (Boolean ) | If true, calculate the cost for the query without evaluating it.The default value is false . |
Lookup a given repository by the owner and repository name.Arguments for repository
#
Name | Description |
---|
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! ) | The name of the repository. |
owner (String! ) | The login field of a user or organization. |
Lookup a repository owner (ie. either a User or an Organization) by login.Arguments for repositoryOwner
#
Name | Description |
---|
login (String! ) | The username to lookup the owner by. |
Lookup resource by a URL.Arguments for resource
#
Name | Description |
---|
url (URI! ) | The URL. |
Perform a search across resources, returning a maximum of 1,000 results.Arguments for search
#
Name | Description |
---|
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. GitHub search syntax is supported. For more information, see "Searching on GitHub," "Understanding the search syntax," and "Sorting search results.". |
type (SearchType! ) | The types of search items to search within. |
GitHub Security Advisories.Arguments for securityAdvisories
#
Name | Description |
---|
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. |
classifications ([SecurityAdvisoryClassification!] ) | A list of classifications to filter advisories by. |
epssPercentage (Float ) | The EPSS percentage to filter advisories by. |
epssPercentile (Float ) | The EPSS percentile to filter advisories by. |
first (Int ) | Returns the first n elements from the list. |
identifier (SecurityAdvisoryIdentifierFilter ) | Filter advisories by identifier, e.g. GHSA or CVE. |
last (Int ) | Returns the last n elements from the list. |
orderBy (SecurityAdvisoryOrder ) | Ordering options for the returned topics. |
publishedSince (DateTime ) | Filter advisories to those published since a time in the past. |
updatedSince (DateTime ) | Filter advisories to those updated since a time in the past. |
Fetch a Security Advisory by its GHSA ID.Arguments for securityAdvisory
#
Name | Description |
---|
ghsaId (String! ) | GitHub Security Advisory ID. |
Software Vulnerabilities documented by GitHub Security Advisories.Arguments for securityVulnerabilities
#
Name | Description |
---|
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. |
classifications ([SecurityAdvisoryClassification!] ) | A list of advisory classifications to filter vulnerabilities by. |
ecosystem (SecurityAdvisoryEcosystem ) | An ecosystem to filter vulnerabilities by. |
first (Int ) | Returns the first n elements from the list. |
last (Int ) | Returns the last n elements from the list. |
orderBy (SecurityVulnerabilityOrder ) | Ordering options for the returned topics. |
package (String ) | A package name to filter vulnerabilities by. |
severities ([SecurityAdvisorySeverity!] ) | A list of severities to filter vulnerabilities by. |
Users and organizations who can be sponsored via GitHub Sponsors.Arguments for sponsorables
#
Name | Description |
---|
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. |
dependencyEcosystem (SecurityAdvisoryEcosystem ) | Optional filter for which dependencies should be checked for sponsorable owners. Only sponsorable owners of dependencies in this ecosystem will be included. Used when onlyDependencies = true.Upcoming Change on 2022-07-01 UTC Description: dependencyEcosystem will be removed. Use the ecosystem argument instead. Reason: The type is switching from SecurityAdvisoryEcosystem to DependencyGraphEcosystem. |
ecosystem (DependencyGraphEcosystem ) | Optional filter for which dependencies should be checked for sponsorable owners. Only sponsorable owners of dependencies in this ecosystem will be included. Used when onlyDependencies = true. |
first (Int ) | Returns the first n elements from the list. |
last (Int ) | Returns the last n elements from the list. |
onlyDependencies (Boolean ) | Whether only sponsorables who own the viewer's dependencies will be returned. Must be authenticated to use. Can check an organization instead for their dependencies owned by sponsorables by passing orgLoginForDependencies.The default value is false . |
orderBy (SponsorableOrder ) | Ordering options for users and organizations returned from the connection. |
orgLoginForDependencies (String ) | Optional organization username for whose dependencies should be checked. Used when onlyDependencies = true. Omit to check your own dependencies. If you are not an administrator of the organization, only dependencies from its public repositories will be considered. |
Arguments for topic
#
Name | Description |
---|
name (String! ) | The topic's name. |
Arguments for user
#
Name | Description |
---|
login (String! ) | The user's login. |
The currently authenticated user.