Search

Enterprise Cloud

Enterprise Server 3.10

Enterprise Server 3.11

Enterprise Server 3.7

Enterprise Server 3.8

Enterprise Server 3.9

Free, Pro, & Team

GitHub AE

REST API

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Help us make these docs great!

Actions

Enter a search term to find it in the GitHub Docs.

Search - GitHub AE Docs

Use the REST API to search for specific items on GitHub AE.

Quickstart

Comparing GitHub's APIs

Resources in the REST API

Rate limits

Media types

Authenticating

Keeping API credentials secure

Troubleshooting

Libraries

Issue event types

GitHub event types

Endpoints for GitHub App installation tokens

Endpoints for GitHub App user tokens

Permissions for GitHub Apps

Overview

Using the API

Script with JavaScript

Script with Ruby

Discover resources for a user

Delivering deployments

Rendering data as graphs

Working with comments

Pagination

Building a CI server

Best practices

Get started - Git database

Get started - Checks

Encrypt secrets

Guides

Artifacts

Permissions

Secrets

Self-hosted runner groups

Self-hosted runners

Workflow jobs

Workflow runs

Workflows

Events

Feeds

Notifications

Starring

Watching

Activity

GitHub Apps

Installations

OAuth Authorizations

Webhooks

Apps

Branches

Protected branches

Check Runs

Check Suites

Checks

Code Scanning

Codes of conduct

Collaborators

Invitations

Commits

Commit comments

Commit statuses

Deploy keys

Deployment branch policies

Deployments

Environments

Deployment statuses

Emojis

Admin stats

Announcement

Audit log

Global Webhooks

License

Organizations

Pre-receive Environments

Users

Enterprise administration

Gists

Comments

Blobs

References

Trees

Git database

Gitignore

Issues

Assignees

Labels

Milestones

Timeline

Licenses

Markdown

Statistics

Metrics

Migrations

Members

Outside Collaborators

Pages

Boards

Cards

Columns

Project boards

Pulls

Review comments

Review requests

Reviews

Rate limit

Reactions

Releases

Release Assets

Autolinks

Forks

Git LFS

Repositories

Secret scanning

Teams

Discussion comments

Discussions

External groups

Followers

GPG Keys

Git SSH Keys

classes.js

Searches for query terms inside of a file. This method returns up to 100 results <a href="https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api">per page</a>.
When searching for code, you can get text match metadata for the file content and file path fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href="https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata">Text match metadata</a>.
For example, if you want to find the definition of the <code>addClass</code> function inside <a href="https://github.com/jquery/jquery">jQuery</a> repository, your query would look something like this:
<code>q=addClass+in:file+language:js+repo:jquery/jquery</code>
This query searches for the keyword <code>addClass</code> within a file's contents. The query limits the search to files where the language is JavaScript in the <code>jquery/jquery</code> repository.
Considerations for code search:
Due to the complexity of searching code, there are a few restrictions on how searches are performed:
<ul>
<li>Only the default branch is considered. In most cases, this will be the <code>master</code> branch.</li>
<li>Only files smaller than 384 KB are searchable.</li>
<li>You must always include at least one search term when searching source code. For example, searching for <a href="https://github.com/search?utf8=%E2%9C%93&#x26;q=language%3Ago&#x26;type=Code"><code>language:go</code></a> is not valid, while <a href="https://github.com/search?utf8=%E2%9C%93&#x26;q=amazing+language%3Ago&#x26;type=Code"><code>amazing language:go</code></a> is.</li>
</ul>
This endpoint requires you to authenticate and limits you to 10 requests per minute.

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub AE. The REST API supports the same qualifiers as the web interface for GitHub AE. To learn more about the format of the query, see <a href="https://docs.github.com/github-ae@latest/rest/search/search#constructing-a-search-query">Constructing a search query</a>. See "<a href="https://docs.github.com/github-ae@latest/search-github/searching-on-github/searching-code">Searching code</a>" for a detailed list of qualifiers.

This field is deprecated. Sorts the results of your query. Can only be <code>indexed</code>, which indicates how recently a file has been indexed by the GitHub AE search infrastructure. Default: <a href="https://docs.github.com/github-ae@latest/rest/search/search#ranking-search-results">best match</a>

sort

This field is deprecated. Determines whether the first search result returned is the highest number of matches (<code>desc</code>) or lowest number of matches (<code>asc</code>). This parameter is ignored unless you provide <code>sort</code>.

order

The number of results per page (max 100).

per_page

Page number of the results to fetch.

page

Validation failed, or the endpoint has been spammed.

Search code

Find commits via various criteria on the default branch (usually <code>main</code>). This method returns up to 100 results <a href="https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api">per page</a>.
When searching for commits, you can get text match metadata for the message field when you provide the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href="https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata">Text match
metadata</a>.
For example, if you want to find commits related to CSS in the <a href="https://github.com/octocat/Spoon-Knife">octocat/Spoon-Knife</a> repository. Your query would look something like this:
<code>q=repo:octocat/Spoon-Knife+css</code>

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub AE. The REST API supports the same qualifiers as the web interface for GitHub AE. To learn more about the format of the query, see <a href="https://docs.github.com/github-ae@latest/rest/search/search#constructing-a-search-query">Constructing a search query</a>. See "<a href="https://docs.github.com/github-ae@latest/search-github/searching-on-github/searching-commits">Searching commits</a>" for a detailed list of qualifiers.

Sorts the results of your query by <code>author-date</code> or <code>committer-date</code>. Default: <a href="https://docs.github.com/github-ae@latest/rest/search/search#ranking-search-results">best match</a>

Determines whether the first search result returned is the highest number of matches (<code>desc</code>) or lowest number of matches (<code>asc</code>). This parameter is ignored unless you provide <code>sort</code>.

Search commits

Line Number Indexes Beyond 20 Not Displayed

Find issues by state and keyword. This method returns up to 100 results <a href="https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api">per page</a>.
When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted
search results, see <a href="https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata">Text match metadata</a>.
For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.
<code>q=windows+label:bug+language:python+state:open&#x26;sort=created&#x26;order=asc</code>
This query searches for the keyword <code>windows</code>, within any open issue that is labeled as <code>bug</code>. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.
Note: For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the <code>is:issue</code> or <code>is:pull-request</code> qualifier will receive an HTTP <code>422 Unprocessable Entity</code> response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the <code>is</code> qualifier, see "<a href="https://docs.github.com/github-ae@latest/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests">Searching only issues or pull requests</a>."

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub AE. The REST API supports the same qualifiers as the web interface for GitHub AE. To learn more about the format of the query, see <a href="https://docs.github.com/github-ae@latest/rest/search/search#constructing-a-search-query">Constructing a search query</a>. See "<a href="https://docs.github.com/github-ae@latest/search-github/searching-on-github/searching-issues-and-pull-requests">Searching issues and pull requests</a>" for a detailed list of qualifiers.

Sorts the results of your query by the number of <code>comments</code>, <code>reactions</code>, <code>reactions-+1</code>, <code>reactions--1</code>, <code>reactions-smile</code>, <code>reactions-thinking_face</code>, <code>reactions-heart</code>, <code>reactions-tada</code>, or <code>interactions</code>. You can also sort results by how recently the items were <code>created</code> or <code>updated</code>, Default: <a href="https://docs.github.com/github-ae@latest/rest/search/search#ranking-search-results">best match</a>

Search issues and pull requests

enhancement

Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results <a href="https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api">per page</a>.
When searching for labels, you can get text match metadata for the label name and description fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href="https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata">Text match metadata</a>.
For example, if you want to find labels in the <code>linguist</code> repository that match <code>bug</code>, <code>defect</code>, or <code>enhancement</code>. Your query might look like this:
<code>q=bug+defect+enhancement&#x26;repository_id=64778136</code>
The labels that best match the query appear first in the search results.

repository_id

The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see <a href="https://docs.github.com/github-ae@latest/rest/search/search#constructing-a-search-query">Constructing a search query</a>.

Sorts the results of your query by when the label was <code>created</code> or <code>updated</code>. Default: <a href="https://docs.github.com/github-ae@latest/rest/search/search#ranking-search-results">best match</a>

Search labels

https://api.github.com/repos/dtrupenn/Tetris/contents/{+path}

A C implementation of Tetris using Pennsim through LC4

Tetris

Find repositories via various criteria. This method returns up to 100 results <a href="https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api">per page</a>.
When searching for repositories, you can get text match metadata for the name and description fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href="https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata">Text match metadata</a>.
For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:
<code>q=tetris+language:assembly&#x26;sort=stars&#x26;order=desc</code>
This query searches for repositories with the word <code>tetris</code> in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub AE. The REST API supports the same qualifiers as the web interface for GitHub AE. To learn more about the format of the query, see <a href="https://docs.github.com/github-ae@latest/rest/search/search#constructing-a-search-query">Constructing a search query</a>. See "<a href="https://docs.github.com/github-ae@latest/articles/searching-for-repositories/">Searching for repositories</a>" for a detailed list of qualifiers.

Sorts the results of your query by number of <code>stars</code>, <code>forks</code>, or <code>help-wanted-issues</code> or how recently the items were <code>updated</code>. Default: <a href="https://docs.github.com/github-ae@latest/rest/search/search#ranking-search-results">best match</a>

Search repositories

Ruby was developed by Yukihiro "Matz" Matsumoto in 1995 with the intent of having an easily readable programming language. It is integrated with the Rails framework to create dynamic web-applications. Ruby's syntax is similar to that of Perl and Python.

ruby

Ruby is a scripting language designed for simplified object-oriented programming.

Ruby on Rails (Rails) is a web application framework written in Ruby. It is meant to help simplify the building of complex websites.

rails

Ruby on Rails (Rails) is a web application framework written in Ruby.

Python is a dynamically typed programming language designed by Guido Van Rossum. Much like the programming language Ruby, Python was designed to be easily read by programmers. Because of its large following and many libraries, Python can be implemented and used to do anything from webpages to scientific research.

python

Python is a dynamically typed programming language.

Jekyll is a blog-aware, site generator written in Ruby. It takes raw text files, runs it through a renderer and produces a publishable static website.

jekyll

Jekyll is a simple, blog-aware static site generator.

Sass is a stylesheet language with a main implementation in Ruby. It is an extension of CSS that makes improvements to the old stylesheet format, such as being able to declare variables and using a cleaner nesting syntax.

sass

Sass is a stable extension to classic CSS.

Homebrew is a package manager for Apple's macOS operating system. It simplifies the installation of software and is popular in the Ruby on Rails community.

homebrew

Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results <a href="https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api">per page</a>. See "<a href="https://docs.github.com/github-ae@latest/articles/searching-topics/">Searching topics</a>" for a detailed list of qualifiers.
When searching for topics, you can get text match metadata for the topic's short_description, description, name, or display_name field when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href="https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata">Text match metadata</a>.
For example, if you want to search for topics related to Ruby that are featured on <a href="https://github.com/topics">https://github.com/topics</a>. Your query might look like this:
<code>q=ruby+is:featured</code>
This query searches for topics with the keyword <code>ruby</code> and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub AE. The REST API supports the same qualifiers as the web interface for GitHub AE. To learn more about the format of the query, see <a href="https://docs.github.com/github-ae@latest/rest/search/search#constructing-a-search-query">Constructing a search query</a>.

Search topics

Find users via various criteria. This method returns up to 100 results <a href="https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api">per page</a>.
When searching for users, you can get text match metadata for the issue login, public email, and name fields when you pass the <code>text-match</code> media type. For more details about highlighting search results, see <a href="https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata">Text match metadata</a>. For more details about how to receive highlighted search results, see <a href="https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata">Text match metadata</a>.
For example, if you're looking for a list of popular users, you might try this query:
<code>q=tom+repos:%3E42+followers:%3E1000</code>
This query searches for users with the name <code>tom</code>. The results are restricted to users with more than 42 repositories and over 1,000 followers.
This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "<a href="https://docs.github.com/github-ae@latest/graphql/reference/queries#search">GraphQL Queries</a>."

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub AE. The REST API supports the same qualifiers as the web interface for GitHub AE. To learn more about the format of the query, see <a href="https://docs.github.com/github-ae@latest/rest/search/search#constructing-a-search-query">Constructing a search query</a>. See "<a href="https://docs.github.com/github-ae@latest/search-github/searching-on-github/searching-users">Searching users</a>" for a detailed list of qualifiers.

Sorts the results of your query by number of <code>followers</code> or <code>repositories</code>, or when the person <code>joined</code> GitHub AE. Default: <a href="https://docs.github.com/github-ae@latest/rest/search/search#ranking-search-results">best match</a>