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. |
enterpriseAdministratorInvitation
Look up a pending enterprise administrator invitation by invitee, enterprise and role.
Arguments for enterpriseAdministratorInvitation
Name | Description |
---|---|
| The slug of the enterprise the user was invited to join. |
| The role for the business member invitation. |
| The login of the user invited to join the business. |
enterpriseAdministratorInvitationByToken
Look up a pending enterprise administrator invitation by invitation token.
Arguments for enterpriseAdministratorInvitationByToken
Name | Description |
---|---|
| The invitation token sent with the invitation email. |
enterpriseMemberInvitation
Look up a pending enterprise unaffiliated member invitation by invitee and enterprise.
enterpriseMemberInvitationByToken
Look up a pending enterprise unaffiliated member invitation by invitation token.
Arguments for enterpriseMemberInvitationByToken
Name | Description |
---|---|
| The invitation token sent with the invitation email. |
license
Look up an open source license by its key.
marketplaceCategories
Get alphabetically sorted list of Marketplace categories.
Type: [MarketplaceCategory!]!
marketplaceListing
Look up a single Marketplace listing.
Type: MarketplaceListing
Arguments for marketplaceListing
Name | Description |
---|---|
| Select the listing that matches this slug. It's the short name of the listing used in its URL. |
marketplaceListings
Look up Marketplace listings.
Arguments for marketplaceListings
Name | Description |
---|---|
| Select listings that can be administered by the specified user. |
| Returns the elements in the list that come after the specified cursor. |
| Select listings visible to the viewer even if they are not approved. If omitted or false, only approved listings will be returned. |
| Returns the elements in the list that come before the specified cursor. |
| Select only listings with the given category. |
| Returns the first n elements from the list. |
| Returns the last n elements from the list. |
| Select listings for products owned by the specified organization. |
| Select only listings where the primary category matches the given category slug. The default value is |
| Select the listings with these slugs, if they are visible to the viewer. |
| Also check topic aliases for the category slug. |
| Select listings to which user has admin access. If omitted, listings visible to the viewer are returned. |
| Select only listings that offer a free trial. The default value is |
node
Fetches an object given its ID.
nodes
Lookup nodes by a list of IDs.
organization
Lookup a organization by login.
Type: Organization
Arguments for organization
Name | Description |
---|---|
| The organization's login. |
rateLimit
The client's rate limit information.
relay
Workaround for re-exposing the root query object. (Refer to https://github.com/facebook/relay/issues/112 for more information.).
Type: Query!
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. |
| Returns the first n elements from the list. |
| Filter advisories by identifier, e.g. GHSA or CVE. |
| Returns the last n elements from the list. |
| Ordering options for the returned topics. |
| 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. |
| Ordering options for the returned topics. |
| A package name to filter vulnerabilities by. |
| A list of severities to filter vulnerabilities by. |
sponsorables
Users and organizations who can be sponsored via GitHub Sponsors.
Arguments for sponsorables
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. |
| 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. Upcoming Change on 2022-07-01 UTC
Description: |
| 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. |
| Returns the first n elements from the list. |
| Returns the last n elements from the list. |
| 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 |
| Ordering options for users and organizations returned from the connection. |
| 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. |
topic
Look up a topic by name.
user
Lookup a user by login.