Queries

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."

Note: For user-to-server GitHub App requests, 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.

Connections

marketplaceListings

Typ: MarketplaceListingConnection!

Look up Marketplace listings.

Arguments

Name Beschreibung

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

Typ: SearchResultItemConnection!

Perform a search across resources.

Arguments

Name Beschreibung

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

Typ: SecurityAdvisoryConnection!

GitHub Security Advisories.

Arguments

Name Beschreibung

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

Typ: SecurityVulnerabilityConnection!

Software Vulnerabilities documented by GitHub Security Advisories.

Arguments

Name Beschreibung

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.


sponsorables

Typ: SponsorableItemConnection!

Users and organizations who can be sponsored via GitHub Sponsors.

Arguments

Name Beschreibung

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.

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.


Fields

codeOfConduct

Typ: CodeOfConduct

Look up a code of conduct by its key.

Arguments

Name Beschreibung

key (String!)

The code of conduct's key.


codesOfConduct

Typ: [CodeOfConduct]

Look up a code of conduct by its key.

Arguments

Name Beschreibung

enterprise

Typ: Enterprise

Look up an enterprise by URL slug.

Arguments

Name Beschreibung

invitationToken (String)

The enterprise invitation token.

slug (String!)

The enterprise URL slug.


enterpriseAdministratorInvitation

Typ: EnterpriseAdministratorInvitation

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

Arguments

Name Beschreibung

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

Typ: EnterpriseAdministratorInvitation

Look up a pending enterprise administrator invitation by invitation token.

Arguments

Name Beschreibung

invitationToken (String!)

The invitation token sent with the invitation email.


license

Typ: License

Look up an open source license by its key.

Arguments

Name Beschreibung

key (String!)

The license's downcased SPDX ID.


licenses

Typ: [License]!

Return a list of known open source licenses.

Arguments

Name Beschreibung

marketplaceCategories

Typ: [MarketplaceCategory!]!

Get alphabetically sorted list of Marketplace categories.

Arguments

Name Beschreibung

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

Typ: MarketplaceCategory

Look up a Marketplace category by its slug.

Arguments

Name Beschreibung

slug (String!)

The URL slug of the category.

useTopicAliases (Boolean)

Also check topic aliases for the category slug.


marketplaceListing

Typ: MarketplaceListing

Look up a single Marketplace listing.

Arguments

Name Beschreibung

slug (String!)

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


meta

Typ: GitHubMetadata!

Return information about the GitHub instance.

Arguments

Name Beschreibung

node

Typ: Node

Fetches an object given its ID.

Arguments

Name Beschreibung

id (ID!)

ID of the object.


nodes

Typ: [Node]!

Lookup nodes by a list of IDs.

Arguments

Name Beschreibung

ids ([ID!]!)

The list of node IDs.


organization

Typ: Organization

Lookup a organization by login.

Arguments

Name Beschreibung

login (String!)

The organization's login.


rateLimit

Typ: RateLimit

The client's rate limit information.

Arguments

Name Beschreibung

dryRun (Boolean)

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

The default value is false.


relay

Typ: Query!

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

Arguments

Name Beschreibung

repository

Typ: Repository

Lookup a given repository by the owner and repository name.

Arguments

Name Beschreibung

name (String!)

The name of the repository.

owner (String!)

The login field of a user or organization.


repositoryOwner

Typ: RepositoryOwner

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

Arguments

Name Beschreibung

login (String!)

The username to lookup the owner by.


resource

Typ: UniformResourceLocatable

Lookup resource by a URL.

Arguments

Name Beschreibung

url (URI!)

The URL.


securityAdvisory

Typ: SecurityAdvisory

Fetch a Security Advisory by its GHSA ID.

Arguments

Name Beschreibung

ghsaId (String!)

GitHub Security Advisory ID.


topic

Typ: Topic

Look up a topic by name.

Arguments

Name Beschreibung

name (String!)

The topic's name.


user

Typ: User

Lookup a user by login.

Arguments

Name Beschreibung

login (String!)

The user's login.


viewer

Typ: User!

The currently authenticated user.

Arguments

Name Beschreibung

Did this doc help you?Privacy policy

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

Oder, learn how to contribute.