Queries

In this article

Did this doc help you?

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Or, learn how to contribute.

About queries

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

Type: MarketplaceListingConnection!

Look up Marketplace listings.

Arguments

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.


search

Type: SearchResultItemConnection!

Perform a search across resources.

Arguments

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.

type (SearchType!)

The types of search items to search within.


securityAdvisories

Type: SecurityAdvisoryConnection!

GitHub Security Advisories.

Arguments

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.

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.


securityVulnerabilities

Type: SecurityVulnerabilityConnection!

Software Vulnerabilities documented by GitHub Security Advisories.

Arguments

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.

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.


Fields

codeOfConduct

Type: CodeOfConduct

Look up a code of conduct by its key.

Arguments

Name Description

key (String!)

The code of conduct's key.


codesOfConduct

Type: [CodeOfConduct]

Look up a code of conduct by its key.


enterprise

Type: Enterprise

Look up an enterprise by URL slug.

Arguments

Name Description

invitationToken (String)

The enterprise invitation token.

slug (String!)

The enterprise URL slug.


enterpriseAdministratorInvitation

Type: EnterpriseAdministratorInvitation

Look up a pending enterprise administrator invitation by invitee, enterprise and role.

Arguments

Name Description

enterpriseSlug (String!)

The slug of the enterprise the user was invited to join.

role (EnterpriseAdministratorRole!)

The role for the business member invitation.

userLogin (String!)

The login of the user invited to join the business.


enterpriseAdministratorInvitationByToken

Type: EnterpriseAdministratorInvitation

Look up a pending enterprise administrator invitation by invitation token.

Arguments

Name Description

invitationToken (String!)

The invitation token sent with the invitation email.


license

Type: License

Look up an open source license by its key.

Arguments

Name Description

key (String!)

The license's downcased SPDX ID.


licenses

Type: [License]!

Return a list of known open source licenses.


marketplaceCategories

Type: [MarketplaceCategory!]!

Get alphabetically sorted list of Marketplace categories.

Arguments

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.


marketplaceCategory

Type: MarketplaceCategory

Look up a Marketplace category by its slug.

Arguments

Name Description

slug (String!)

The URL slug of the category.

useTopicAliases (Boolean)

Also check topic aliases for the category slug.


marketplaceListing

Type: MarketplaceListing

Look up a single Marketplace listing.

Arguments

Name Description

slug (String!)

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


meta

Type: GitHubMetadata!

Return information about the GitHub instance.


node

Type: Node

Fetches an object given its ID.

Arguments

Name Description

id (ID!)

ID of the object.


nodes

Type: [Node]!

Lookup nodes by a list of IDs.

Arguments

Name Description

ids ([ID!]!)

The list of node IDs.


organization

Type: Organization

Lookup a organization by login.

Arguments

Name Description

login (String!)

The organization's login.


rateLimit

Type: RateLimit

The client's rate limit information.

Arguments

Name Description

dryRun (Boolean)

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

The default value is false.


relay

Type: Query!

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


repository

Type: Repository

Lookup a given repository by the owner and repository name.

Arguments

Name Description

name (String!)

The name of the repository.

owner (String!)

The login field of a user or organization.


repositoryOwner

Type: RepositoryOwner

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

Arguments

Name Description

login (String!)

The username to lookup the owner by.


resource

Type: UniformResourceLocatable

Lookup resource by a URL.

Arguments

Name Description

url (URI!)

The URL.


securityAdvisory

Type: SecurityAdvisory

Fetch a Security Advisory by its GHSA ID.

Arguments

Name Description

ghsaId (String!)

GitHub Security Advisory ID.


sponsorsListing

Type: SponsorsListing

Look up a single Sponsors Listing.

Deprecation notice

sponsorsListing is deprecated.

Query.sponsorsListing will be removed. Use Sponsorable.sponsorsListing instead. Removal on 2020-04-01 UTC.

Arguments

Name Description

slug (String!)

Select the Sponsors listing which matches this slug.


topic

Type: Topic

Look up a topic by name.

Arguments

Name Description

name (String!)

The topic's name.


user

Type: User

Lookup a user by login.

Arguments

Name Description

login (String!)

The user's login.


viewer

Type: User!

The currently authenticated user.


Did this doc help you?

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Or, learn how to contribute.