Query

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 more information, see "About queries."

Connections

marketplaceListings (MarketplaceListingConnection!)

Look up Marketplace listings

Argument Type 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.

search (SearchResultItemConnection!)

Perform a search across resources.

Argument Type 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.

type SearchType!

The types of search items to search within.

securityAdvisories (SecurityAdvisoryConnection!)

This part of the schema is currently available for developers to preview. During this preview period, the API may change without any advance notice. Please see the Access to GitHub Security Advisories preview for more details.

Note: The GraphQL resources under preview cannot be accessed via the Explorer at this time.

GitHub Security Advisories

Argument Type 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.

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.

The default value is {"field"=>"UPDATED_AT", "direction"=>"DESC"}.

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.

securityVulnerabilities (SecurityVulnerabilityConnection!)

This part of the schema is currently available for developers to preview. During this preview period, the API may change without any advance notice. Please see the Access to GitHub Security Advisories preview for more details.

Note: The GraphQL resources under preview cannot be accessed via the Explorer at this time.

Software Vulnerabilities documented by GitHub Security Advisories

Argument Type 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.

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.

The default value is {"field"=>"UPDATED_AT", "direction"=>"DESC"}.

package String

A package name to filter vulnerabilities by.

severities [SecurityAdvisorySeverity!]

A list of severities to filter vulnerabilities by.

Fields

codeOfConduct (CodeOfConduct)

Look up a code of conduct by its key

Argument Type Description
key String!

The code of conduct's key

codesOfConduct ([CodeOfConduct])

Look up a code of conduct by its key

license (License)

Look up an open source license by its key

Argument Type Description
key String!

The license's downcased SPDX ID

licenses ([License]!)

Return a list of known open source licenses

marketplaceCategories ([MarketplaceCategory!]!)

Get alphabetically sorted list of Marketplace categories

Argument Type 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.

marketplaceCategory (MarketplaceCategory)

Look up a Marketplace category by its slug.

Argument Type Description
slug String!

The URL slug of the category.

useTopicAliases Boolean

Also check topic aliases for the category slug

marketplaceListing (MarketplaceListing)

Look up a single Marketplace listing

Argument Type Description
slug String!

Select the listing that matches this slug. It's the short name of the listing used in its URL.

meta (GitHubMetadata!)

Return information about the GitHub instance

node (Node)

Fetches an object given its ID.

Argument Type Description
id ID!

ID of the object.

nodes ([Node]!)

Lookup nodes by a list of IDs.

Argument Type Description
ids [ID!]!

The list of node IDs.

organization (Organization)

Lookup a organization by login.

Argument Type Description
login String!

The organization's login.

rateLimit (RateLimit)

The client's rate limit information.

Argument Type Description
dryRun Boolean

If true, calculate the cost for the query without evaluating it

The default value is false.

relay (Query!)

Hack to workaround https://github.com/facebook/relay/issues/112 re-exposing the root query object

repository (Repository)

Lookup a given repository by the owner and repository name.

Argument Type Description
name String!

The name of the repository

owner String!

The login field of a user or organization

repositoryOwner (RepositoryOwner)

Lookup a repository owner (ie. either a User or an Organization) by login.

Argument Type Description
login String!

The username to lookup the owner by.

resource (UniformResourceLocatable)

Lookup resource by a URL.

Argument Type Description
url URI!

The URL.

securityAdvisory (SecurityAdvisory)

This part of the schema is currently available for developers to preview. During this preview period, the API may change without any advance notice. Please see the Access to GitHub Security Advisories preview for more details.

Note: The GraphQL resources under preview cannot be accessed via the Explorer at this time.

Fetch a Security Advisory by its GHSA ID

Argument Type Description
ghsaId String!

GitHub Security Advisory ID.

topic (Topic)

Look up a topic by name.

Argument Type Description
name String!

The topic's name.

user (User)

Lookup a user by login.

Argument Type Description
login String!

The user's login.

viewer (User!)

The currently authenticated user.