Search

Enterprise Cloud

Enterprise Server

Enterprise Server 3.6

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!

Help for wherever you are on your GitHub journey.

Can be one of

Name

All {{ name }} guides

{{ name }} learning paths

Actions

GitHub began rolling these changes out to enterprises on

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

Search - GitHub Docs

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

English

Simplified Chinese

Spanish

Portuguese

Russian

Japanese

French

German

Korean

Quickstart

About GitHub's APIs

Resources in the REST API

API Versions

Media types

Authenticating

Keeping API credentials secure

Troubleshooting

Libraries

OpenAPI description

Endpoints for GitHub App installation tokens

Endpoints for GitHub App user tokens

Endpoints for fine-grained PATs

Permissions for GitHub Apps

Permissions for fine-grained PATs

Breaking changes

Overview

Using the API

Script with JavaScript

Discover resources for a user

Delivering deployments

Rendering data as graphs

Working with comments

Pagination

Building a CI server

Integrator best practices

Get started - Git database

Get started - Checks

Guides

Artifacts

Cache

OIDC

Permissions

Secrets

Self-hosted runners

Variables

Workflow jobs

Workflow runs

Workflows

Events

Feeds

Notifications

Starring

Watching

Activity

GitHub Apps

Installations

Marketplace

OAuth Authorizations

Webhooks

Apps

Billing

Branches

Protected branches

Check Runs

Check Suites

Checks

Codes of conduct

Code Scanning

Codespaces

Organizations

Organization secrets

Machines

Repository secrets

User secrets

Collaborators

Invitations

Commits

Commit comments

Commit statuses

Copilot for Business

Copilot

Alerts

Dependabot

Dependency review

Dependency submission

Software bill of materials (SBOM)

Dependency Graph

Deploy keys

Deployment branch policies

Deployments

Environments

Protection rules

Deployment statuses

Emojis

Gists

Comments

Blobs

References

Trees

Git database

Gitignore

Organization

Repository

User

Interactions

Issues

Assignees

Labels

Milestones

Timeline

Licenses

Markdown

Community

Statistics

Traffic

Metrics

Source imports

Users

Migrations

Blocking users

Members

Outside Collaborators

Personal access tokens

Rules

Security Managers

Packages

Pages

Boards

Cards

Columns

Projects (classic)

Pulls

Review comments

Review requests

Reviews

Rate limit

Reactions

Releases

Release Assets

Autolinks

Forks

Git LFS

Repositories

Secret scanning

Repository security advisories

Security advisories

Teams

Discussion comments

Discussions

Emails

Followers

GPG Keys

Git SSH Keys

SSH signing keys

Social accounts

Repository Webhook Configuration

Repository Webhook Deliveries

Repository Webhooks

Repository webhooks

classes.js

Searches for query terms inside of a file. This method returns up to 100 results <a href="https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination">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/rest/reference/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. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see <a href="https://docs.github.com/rest/reference/search#constructing-a-search-query">Constructing a search query</a>. See "<a href="https://docs.github.com/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 search infrastructure. Default: <a href="https://docs.github.com/rest/reference/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/rest/overview/resources-in-the-rest-api#pagination">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/rest/reference/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. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see <a href="https://docs.github.com/rest/reference/search#constructing-a-search-query">Constructing a search query</a>. See "<a href="https://docs.github.com/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/rest/reference/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