This version of GitHub Enterprise Server was discontinued on 2024-07-09. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise Server. For help with the upgrade, contact GitHub Enterprise support.

Queries

The query type defines GraphQL operations that retrieve data from the server.

In this article

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 "Forming calls with GraphQL."

Note: 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.

codeOfConduct

Look up a code of conduct by its key.

Arguments for codeOfConduct

NameDescription

key (String!)

The code of conduct's key.

codesOfConduct

Look up a code of conduct by its key.

enterprise

Look up an enterprise by URL slug.

Arguments for enterprise

NameDescription

invitationToken (String)

The enterprise invitation token.

slug (String!)

The enterprise URL slug.

license

Look up an open source license by its key.

Type: License

Arguments for license

NameDescription

key (String!)

The license's downcased SPDX ID.

licenses

Return a list of known open source licenses.

meta

Return information about the GitHub instance.

node

Fetches an object given its ID.

Type: Node

Arguments for node

NameDescription

id (ID!)

ID of the object.

nodes

Lookup nodes by a list of IDs.

Type: [Node]!

Arguments for nodes

NameDescription

ids ([ID!]!)

The list of node IDs.

organization

Lookup a organization by login.

Arguments for organization

NameDescription

login (String!)

The organization's login.

organizations

A list of organizations.

Arguments for organizations

NameDescription

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 (OrganizationOrder)

Ordering options for the User's organizations.

rateLimit

The client's rate limit information.

Type: RateLimit

Arguments for rateLimit

NameDescription

dryRun (Boolean)

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

The default value is false.

relay

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

Type: Query!

repository

Lookup a given repository by the owner and repository name.

Arguments for repository

NameDescription

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.

repositoryOwner

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

Arguments for repositoryOwner

NameDescription

login (String!)

The username to lookup the owner by.

resource

Lookup resource by a URL.

Arguments for resource

NameDescription

url (URI!)

The URL.

Perform a search across resources, returning a maximum of 1,000 results.

Arguments for search

NameDescription

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

GitHub Security Advisories.

Arguments for securityAdvisories

NameDescription

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.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

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.

securityAdvisory

Fetch a Security Advisory by its GHSA ID.

Arguments for securityAdvisory

NameDescription

ghsaId (String!)

GitHub Security Advisory ID.

securityVulnerabilities

Software Vulnerabilities documented by GitHub Security Advisories.

Arguments for securityVulnerabilities

NameDescription

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.

package (String)

A package name to filter vulnerabilities by.

severities ([SecurityAdvisorySeverity!])

A list of severities to filter vulnerabilities by.

topic

Look up a topic by name.

Type: Topic

Arguments for topic

NameDescription

name (String!)

The topic's name.

user

Lookup a user by login.

Type: User

Arguments for user

NameDescription

login (String!)

The user's login.

users

A list of users.

Arguments for users

NameDescription

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.

viewer

The currently authenticated user.

Type: User!