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.
Type: CodeOfConduct
Arguments for codeOfConduct
| Name | Description |
|---|---|
| The code of conduct's key. |
codesOfConduct
Look up a code of conduct by its key.
Type: [CodeOfConduct]
enterprise
Look up an enterprise by URL slug.
Type: Enterprise
Arguments for enterprise
| Name | Description |
|---|---|
| The enterprise invitation token. |
| The enterprise URL slug. |
id
ID of the object.
Type: ID!
license
Look up an open source license by its key.
Type: License
Arguments for license
| Name | Description |
|---|---|
| The license's downcased SPDX ID. |
licenses
Return a list of known open source licenses.
Type: [License]!
meta
Return information about the GitHub instance.
Type: GitHubMetadata!
node
Fetches an object given its ID.
Type: Node
Arguments for node
| Name | Description |
|---|---|
| ID of the object. |
nodes
Lookup nodes by a list of IDs.
Type: [Node]!
Arguments for nodes
| Name | Description |
|---|---|
| The list of node IDs. |
organization
Lookup a organization by login.
Type: Organization
Arguments for organization
| Name | Description |
|---|---|
| The organization's login. |
organizations
A list of organizations.
Type: OrganizationConnection!
Arguments for organizations
| Name | Description |
|---|---|
| Returns the elements in the list that come after the specified cursor. |
| Returns the elements in the list that come before the specified cursor. |
| Returns the first n elements from the list. |
| Returns the last n elements from the list. |
| Ordering options for the User's organizations. |
rateLimit
The client's rate limit information.
Type: RateLimit
Arguments for rateLimit
| Name | Description |
|---|---|
| If true, calculate the cost for the query without evaluating it. The default value is |
relay
Workaround for re-exposing the root query object. (Refer to https://github.com/facebook/relay/issues/112 for more information.).
Type: Query!
repository
Lookup a given repository by the owner and repository name.
Type: Repository
Arguments for repository
| Name | Description |
|---|---|
| Follow repository renames. If disabled, a repository referenced by its old name will return an error. The default value is |
| The name of the repository. |
| The login field of a user or organization. |
repositoryOwner
Lookup a repository owner (ie. either a User or an Organization) by login.
Type: RepositoryOwner
Arguments for repositoryOwner
| Name | Description |
|---|---|
| The username to lookup the owner by. |
resource
Lookup resource by a URL.
Type: UniformResourceLocatable
Arguments for resource
| Name | Description |
|---|---|
| The URL. |
search
Perform a search across resources, returning a maximum of 1,000 results.
Arguments for search
| Name | Description |
|---|---|
| Returns the elements in the list that come after the specified cursor. |
| Returns the elements in the list that come before the specified cursor. |
| Returns the first n elements from the list. |
| Returns the last n elements from the list. |
| The search string to look for. GitHub search syntax is supported. For more information, see "Searching on GitHub," "Understanding the search syntax," and "Sorting search results.". |
| The types of search items to search within. |
securityAdvisories
GitHub Security Advisories.
Arguments for securityAdvisories
| Name | Description |
|---|---|
| Returns the elements in the list that come after the specified cursor. |
| Returns the elements in the list that come before the specified cursor. |
| A list of classifications to filter advisories by. |
| The EPSS percentage to filter advisories by. |
| The EPSS percentile to filter advisories by. |
| Returns the first n elements from the list. |
| Returns the last n elements from the list. |
| Filter advisories to those published since a time in the past. |
| Filter advisories to those updated since a time in the past. |
securityAdvisory
Fetch a Security Advisory by its GHSA ID.
Type: SecurityAdvisory
Arguments for securityAdvisory
| Name | Description |
|---|---|
| GitHub Security Advisory ID. |
securityVulnerabilities
Software Vulnerabilities documented by GitHub Security Advisories.
Arguments for securityVulnerabilities
| Name | Description |
|---|---|
| Returns the elements in the list that come after the specified cursor. |
| Returns the elements in the list that come before the specified cursor. |
| A list of advisory classifications to filter vulnerabilities by. |
| An ecosystem to filter vulnerabilities by. |
| Returns the first n elements from the list. |
| Returns the last n elements from the list. |
| A package name to filter vulnerabilities by. |
| A list of severities to filter vulnerabilities by. |
topic
Look up a topic by name.
Type: Topic
Arguments for topic
| Name | Description |
|---|---|
| The topic's name. |
user
Lookup a user by login.
Type: User
Arguments for user
| Name | Description |
|---|---|
| The user's login. |
users
A list of users.
Type: UserConnection!
Arguments for users
| Name | Description |
|---|---|
| Returns the elements in the list that come after the specified cursor. |
| Returns the elements in the list that come before the specified cursor. |
| Returns the first n elements from the list. |
| Returns the last n elements from the list. |
viewer
The currently authenticated user.
Type: User!