English

Explore by product

GraphQL API
English

This version of GitHub Enterprise was discontinued on 2021-06-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. For help with the upgrade, contact GitHub Enterprise support.

Article version: Enterprise Server 2.21
Article version: Enterprise Server 2.21

Queries

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

organizations

Type: OrganizationConnection!

A list of organizations.

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.

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.

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.

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.

package (String)

A package name to filter vulnerabilities by.

severities ([SecurityAdvisorySeverity!])

A list of severities to filter vulnerabilities by.

users

Type: UserConnection!

A list of users.

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.

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.

Arguments

Name Description

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.

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.

Arguments

Name Description

meta

Type: GitHubMetadata!

Return information about the GitHub instance.

Arguments

Name Description

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.

Arguments

Name Description

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.

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.

Arguments

Name Description