# REST-API-Endpunkte für die Suche Verwenden Sie die REST-API, um nach bestimmten Elementen auf GitHub zu suchen. ## Informationen zur Suche Du kannst die REST-API verwenden, um nach dem bestimmten Element zu suchen, das du finden möchtest. Du kannst beispielsweise bestimmte Benutzer\*innen oder Dateien in einem Repository suchen. Du kannst dir die Such-API wie eine Google-Suche vorstellen. Sie ist so konzipiert, dass du das eine Ergebnis findest, nach dem du suchst (oder vielleicht die wenigen Ergebnisse, nach denen du suchst). Wie bei der Google-Suche möchtest du manchmal einige Seiten mit Suchergebnissen anzeigen, damit du das Element finden kannst, das deine Anforderungen am besten erfüllt. Um diesen Bedarf zu erfüllen, stellt die GitHub REST-API **bis zu 1.000 Ergebnisse für jede Suche bereit**. Du kannst deine Suche mithilfe von Abfragen einschränken. Weitere Informationen zur Syntax der Suchabfrage findest du unter [REST-API-Endpunkte für die Suche](/de/enterprise-server@3.20/rest/search/search#constructing-a-search-query). ### Rangliste von Suchergebnissen Wenn keine andere Sortieroption als Abfrageparameter bereitgestellt wird, werden die Ergebnisse nach der besten Übereinstimmung in absteigender Reihenfolge sortiert. Mehrere Faktoren werden kombiniert, um das relevanteste Element an den Anfang der Ergebnisliste zu bringen. ### Ratenbegrenzung > \[!NOTE] > Ratenbegrenzungen sind bei GitHub Enterprise Server standardmäßig deaktiviert. Wende dich an deine Websiteadministrator\*innen, um die Ratenlimits für deine Instanz zu bestätigen. Die REST-API verfügt über ein benutzerdefiniertes Ratenlimit für die Suche. Bei authentifizierten Anforderungen können Sie bis zu 30 Anforderungen pro Minute beschränken. Für nicht authentifizierte Anforderungen ermöglicht die Ratenbegrenzung bis zu 10 Anforderungen pro Minute. Informationen zum Ermitteln der aktuellen Ratenbegrenzung findest du unter [Ratenbegrenzung](/de/enterprise-server@3.20/rest/rate-limit/rate-limit). ### Erstellen einer Suchabfrage Jeder Endpunkt für die Suche verwendet [Abfrageparameter](https://en.wikipedia.org/wiki/Query_string) , um Suchvorgänge GitHubauszuführen. Beispiele, die den Endpunkt und die Abfrageparameter enthalten, findest du bei den einzelnen Endpunkten. Eine Abfrage kann eine beliebige Kombination von Suchqualifizierern enthalten, die auf GitHub unterstützt werden. Das Format der Suchabfrage lautet: ```text SEARCH_KEYWORD_1 SEARCH_KEYWORD_N QUALIFIER_1 QUALIFIER_N ``` Wenn du beispielsweise nach allen *Repositorys* von `defunkt` suchen möchtest, die die Wörter `GitHub` und `Octocat` in der README-Datei enthalten, verwende die folgende Abfrage mit dem Endpunkt *Durchsuchen von Repositorys*: ```text GitHub Octocat in:readme user:defunkt ``` **Hinweis:** Stelle sicher, dass du den bevorzugten HTML-Encoder deiner Sprache verwendest, um deine Abfragezeichenfolgen zu erstellen. Zum Beispiel: ```javascript // JavaScript const queryString = 'q=' + encodeURIComponent('GitHub Octocat in:readme user:defunkt'); ``` Unter [Auf GitHub suchen](/de/enterprise-server@3.20/search-github/searching-on-github) findest du eine vollständige Liste der verfügbaren Qualifizierer, ihr Format und ein Beispiel für ihre Verwendung. Informationen zum Verwenden von Operatoren für den Abgleich mit bestimmten Mengen oder Datumsangaben oder zum Ausschließen von Ergebnissen findest du unter [Grundlagen der Suchsyntax](/de/enterprise-server@3.20/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax). ### Einschränkungen der Abfragelänge Du kannst keine Abfragen verwenden, die: * Sind länger als 256 Zeichen (ohne Operatoren oder Qualifikatoren). * Weisen mehr als fünf `AND`-, `OR`- oder `NOT`-Operatoren auf. Diese Suchabfragen geben eine Fehlermeldung „Überprüfung fehlgeschlagen“ zurück. ### Grenzwerte des Suchbereichs Damit die Geschwindigkeit der REST-API für alle aufrechterhalten wird, wird die Anzahl der Repositorys begrenzt, die von einer Abfrage durchsucht werden. Von der REST-API werden bis zu 4.000 Repositorys gefunden, die deinen Filtern entsprechen, und es werden Ergebnisse aus diesen Repositorys zurückgegeben. ### Zeitüberschreitungen und unvollständige Ergebnisse Damit die Geschwindigkeit der REST-API für alle aufrechterhalten wird, wird die Dauer einer einzelnen Abfrage begrenzt. Für Abfragen, die [das Zeitlimit überschreiten](https://developer.github.com/changes/2014-04-07-understanding-search-results-and-potential-timeouts/), gibt die API die Übereinstimmungen zurück, die bereits vor dem Timeout gefunden wurden, und in der Antwort ist die `incomplete_results`-Eigenschaft auf `true` festgelegt. Das Erreichen des Zeitlimits bedeutet jedoch nicht in jedem Fall, dass die Suchergebnisse unvollständig sind. Es kann sein, dass weitere Ergebnisse gefunden wurden, aber es kann auch sein, dass dies nicht der Fall ist. ### Zugriffsfehler oder fehlende Suchergebnisse Du musst dich erfolgreich authentifizieren und Zugriff auf die Repositorys in deinen Suchabfragen haben. Andernfalls wird ein `422 Unprocessable Entry`-Fehler mit einer Meldung „Überprüfung fehlgeschlagen“ angezeigt. Ihre Suche schlägt z. B. fehl, wenn Ihre Abfrage die Qualifizierer `repo:`, `user:` oder `org:` enthält, die Ressourcen anfordern, auf die Sie keinen Zugriff haben, wenn Sie sich bei GitHub anmelden. Wenn deine Suchabfrage mehrere Ressourcen anfordert, enthält die Antwort nur die Ressourcen, auf die du Zugriff hast, und stellt **keine** Fehlermeldung bereit, die die Ressourcen enthält, die nicht zurückgegeben wurden. Wenn deine Suchabfrage z. B. nach den Repositorys `octocat/test` und `codertocat/test` sucht, du aber nur Zugriff auf `octocat/test` hast, zeigt deine Antwort Suchergebnisse für `octocat/test` und nichts für `codertocat/test`. Dieses Verhalten entspricht der Funktionsweise der Suche auf GitHub. ### Metadaten zur Textübereinstimmung Auf GitHub, können Sie den Kontext verwenden, der von Codeausschnitten und Hervorhebungen in Suchergebnissen bereitgestellt wird. Von den zur Suche verwendeten Endpunkten werden zusätzliche Metadaten zurückgegeben, mit denen du die übereinstimmenden Suchbegriffe beim Anzeigen von Suchergebnissen hervorheben kannst. Für Anforderungen besteht die Option, diese Textfragmente in der Antwort zu erhalten, und jedes Fragment wird von numerischen Offsets begleitet, die die genaue Position jedes übereinstimmenden Suchbegriffs identifizieren. Gib zum Abrufen dieser Metadaten in deinen Suchergebnissen den `text-match`-Medientyp in deiner `Accept`-Kopfzeile an. ```shell application/vnd.github.text-match+json ``` Wenn du den `text-match`-Medientyp bereitstellst, erhältst du einen zusätzlichen Schlüssel namens `text_matches` in der JSON-Nutzlast, der Informationen über die Position deiner Suchbegriffe innerhalb des Texts und die `property` bereitstellt, die den Suchbegriff enthält. Innerhalb des `text_matches`-Arrays enthält jedes Objekt die folgenden Attribute: | Name | BESCHREIBUNG | | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `object_url` | Die URL für die Ressource, die eine Zeichenfolgeneigenschaft enthält, die einem der Suchbegriffe entspricht. | | `object_type` | Der Name für den Typ der Ressource, die in der angegebenen `object_url` vorhanden ist. | | `property` | Der Name einer Eigenschaft der Ressource, die bei `object_url` vorhanden ist. Diese Eigenschaft ist eine Zeichenfolge, die einem der Suchbegriffe entspricht. (In der von `object_url` zurückgegebenen JSON wird der vollständige Inhalt für das `fragment` in der Eigenschaft mit diesem Namen gefunden.) | | `fragment` | Eine Teilmenge des Werts von `property`. Dies ist das Textfragment, das einem oder mehreren Suchbegriffen entspricht. | | `matches` | Ein Array eines oder mehrerer Suchbegriffe, die in `fragment` vorhanden sind. Die Indizes (d. h. „Offsets“) sind relativ zum Fragment. (Sie sind nicht relativ zum *vollständigen* Inhalt von `property`.) | #### Beispiel Mit einem `curl`-Befehl und dem obigen [Beispiel für die Suche nach einem Issue](#search-issues-and-pull-requests) würde unsere API-Anforderung wie folgt aussehen: ```shell curl -H 'Accept: application/vnd.github.text-match+json' \ 'http(s)://HOSTNAME/api/v3/search/issues?q=windows+label:bug \ +language:python+state:open&sort=created&order=asc' ``` Die Antwort enthält ein `text_matches`-Array für jedes Suchergebnis. Im folgenden JSON haben wir zwei Objekte im `text_matches`-Array. Die erste Textübereinstimmung trat in der `body`-Eigenschaft des Issues auf. Es wird ein Fragment aus dem Issuetext angezeigt. Der Suchbegriff (`windows`) wird zweimal innerhalb dieses Fragments angezeigt, und wir haben die Indizes für jedes Vorkommen. Die zweite Textübereinstimmung ist in der `body`-Eigenschaft eines der Issuekommentare aufgetreten. Wir haben die URL für den Issuekommentar. Und natürlich sehen wir ein Fragment aus dem Kommentarinhalt. Der Suchbegriff (`windows`) wird einmal innerhalb dieses Fragments angezeigt. ```json { "text_matches": [ { "object_url": "https://api.github.com/repositories/215335/issues/132", "object_type": "Issue", "property": "body", "fragment": "comprehensive windows font I know of).\n\nIf we can find a commonly distributed windows font that supports them then no problem (we can use html font tags) but otherwise the '(21)' style is probably better.\n", "matches": [ { "text": "windows", "indices": [ 14, 21 ] }, { "text": "windows", "indices": [ 78, 85 ] } ] }, { "object_url": "https://api.github.com/repositories/215335/issues/comments/25688", "object_type": "IssueComment", "property": "body", "fragment": " right after that are a bit broken IMHO :). I suppose we could have some hack that maxes out at whatever the font does...\n\nI'll check what the state of play is on Windows.\n", "matches": [ { "text": "Windows", "indices": [ 163, 170 ] } ] } ] } ``` > \[!NOTE] > Most endpoints use `Authorization: Bearer ` and `Accept: application/vnd.github+json` headers, plus `X-GitHub-Api-Version: 2022-11-28`. Curl examples below omit these standard headers for brevity. ## Search code ``` GET /search/code ``` Searches for query terms inside of a file. This method returns up to 100 results per page. When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata. For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this: q=addClass+in:file+language:js+repo:jquery/jquery This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository. Considerations for code search: Due to the complexity of searching code, there are a few restrictions on how searches are performed: Only the default branch is considered. In most cases, this will be the master branch. Only files smaller than 384 KB are searchable. You must always include at least one search term when searching source code. For example, searching for language:go is not valid, while amazing language:go is. ### Parameters #### Headers * **`accept`** (string) Setting to `application/vnd.github+json` is recommended. #### Path and query parameters * **`q`** (string) (required) The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports different qualifiers than the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See "Searching code" for a detailed list of qualifiers. * **`sort`** (string) Sorts the results of your query. Can only be indexed, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: best match Can be one of: `indexed` * **`order`** (string) Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort. Default: `desc` Can be one of: `desc`, `asc` * **`per_page`** (integer) The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: `30` * **`page`** (integer) The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default: `1` ### HTTP response status codes * **200** - OK * **304** - Not modified * **403** - Forbidden * **422** - Validation failed, or the endpoint has been spammed. * **503** - Service unavailable ### Code examples #### Example **Request:** ```curl curl -L \ -X GET \ http(s)://HOSTNAME/api/v3/search/code ``` **Response schema (Status: 200):** * `total_count`: required, integer * `incomplete_results`: required, boolean * `items`: required, array of `Code Search Result Item`: * `name`: required, string * `path`: required, string * `sha`: required, string * `url`: required, string, format: uri * `git_url`: required, string, format: uri * `html_url`: required, string, format: uri * `repository`: required, `Minimal Repository`: * `id`: required, integer, format: int64 * `node_id`: required, string * `name`: required, string * `full_name`: required, string * `owner`: required, `Simple User`: * `name`: string or null * `email`: string or null * `login`: required, string * `id`: required, integer, format: int64 * `node_id`: required, string * `avatar_url`: required, string, format: uri * `gravatar_id`: required, string or null * `url`: required, string, format: uri * `html_url`: required, string, format: uri * `followers_url`: required, string, format: uri * `following_url`: required, string * `gists_url`: required, string * `starred_url`: required, string * `subscriptions_url`: required, string, format: uri * `organizations_url`: required, string, format: uri * `repos_url`: required, string, format: uri * `events_url`: required, string * `received_events_url`: required, string, format: uri * `type`: required, string * `site_admin`: required, boolean * `starred_at`: string * `user_view_type`: string * `private`: required, boolean * `html_url`: required, string, format: uri * `description`: required, string or null * `fork`: required, boolean * `url`: required, string, format: uri * `archive_url`: required, string * `assignees_url`: required, string * `blobs_url`: required, string * `branches_url`: required, string * `collaborators_url`: required, string * `comments_url`: required, string * `commits_url`: required, string * `compare_url`: required, string * `contents_url`: required, string * `contributors_url`: required, string, format: uri * `deployments_url`: required, string, format: uri * `downloads_url`: required, string, format: uri * `events_url`: required, string, format: uri * `forks_url`: required, string, format: uri * `git_commits_url`: required, string * `git_refs_url`: required, string * `git_tags_url`: required, string * `git_url`: string * `issue_comment_url`: required, string * `issue_events_url`: required, string * `issues_url`: required, string * `keys_url`: required, string * `labels_url`: required, string * `languages_url`: required, string, format: uri * `merges_url`: required, string, format: uri * `milestones_url`: required, string * `notifications_url`: required, string * `pulls_url`: required, string * `releases_url`: required, string * `ssh_url`: string * `stargazers_url`: required, string, format: uri * `statuses_url`: required, string * `subscribers_url`: required, string, format: uri * `subscription_url`: required, string, format: uri * `tags_url`: required, string, format: uri * `teams_url`: required, string, format: uri * `trees_url`: required, string * `clone_url`: string * `mirror_url`: string or null * `hooks_url`: required, string, format: uri * `svn_url`: string * `homepage`: string or null * `language`: string or null * `forks_count`: integer * `stargazers_count`: integer * `watchers_count`: integer * `size`: integer * `default_branch`: string * `open_issues_count`: integer * `is_template`: boolean * `topics`: array of string * `has_issues`: boolean * `has_projects`: boolean * `has_wiki`: boolean * `has_pages`: boolean * `has_downloads`: boolean * `has_discussions`: boolean * `has_pull_requests`: boolean * `pull_request_creation_policy`: string, enum: `all`, `collaborators_only` * `archived`: boolean * `disabled`: boolean * `visibility`: string * `pushed_at`: string or null, format: date-time * `created_at`: string or null, format: date-time * `updated_at`: string or null, format: date-time * `permissions`: object: * `admin`: boolean * `maintain`: boolean * `push`: boolean * `triage`: boolean * `pull`: boolean * `role_name`: string * `temp_clone_token`: string * `delete_branch_on_merge`: boolean * `subscribers_count`: integer * `network_count`: integer * `code_of_conduct`: `Code Of Conduct`: * `key`: required, string * `name`: required, string * `url`: required, string, format: uri * `body`: string * `html_url`: required, string or null, format: uri * `license`: object or null: * `key`: string * `name`: string * `spdx_id`: string * `url`: string or null * `node_id`: string * `forks`: integer * `open_issues`: integer * `watchers`: integer * `allow_forking`: boolean * `web_commit_signoff_required`: boolean * `security_and_analysis`: object or null: * `advanced_security`: object: * `status`: string, enum: `enabled`, `disabled` * `code_security`: object: * `status`: string, enum: `enabled`, `disabled` * `dependabot_security_updates`: object: * `status`: string, enum: `enabled`, `disabled` * `secret_scanning`: object: * `status`: string, enum: `enabled`, `disabled` * `secret_scanning_push_protection`: object: * `status`: string, enum: `enabled`, `disabled` * `secret_scanning_non_provider_patterns`: object: * `status`: string, enum: `enabled`, `disabled` * `custom_properties`: object, additional properties allowed * `score`: required, number * `file_size`: integer * `language`: string or null * `last_modified_at`: string, format: date-time * `line_numbers`: array of string * `text_matches`: array of objects: * `object_url`: string * `object_type`: string or null * `property`: string * `fragment`: string * `matches`: array of objects: * `text`: string * `indices`: array of integer ## Search commits ``` GET /search/commits ``` Find commits via various criteria on the default branch (usually main). This method returns up to 100 results per page. When searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match metadata. For example, if you want to find commits related to CSS in the octocat/Spoon-Knife repository. Your query would look something like this: q=repo:octocat/Spoon-Knife+css ### Parameters #### Headers * **`accept`** (string) Setting to `application/vnd.github+json` is recommended. #### Path and query parameters * **`q`** (string) (required) The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See "Searching commits" for a detailed list of qualifiers. * **`sort`** (string) Sorts the results of your query by author-date or committer-date. Default: best match Can be one of: `author-date`, `committer-date` * **`order`** (string) Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort. Default: `desc` Can be one of: `desc`, `asc` * **`per_page`** (integer) The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: `30` * **`page`** (integer) The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default: `1` ### HTTP response status codes * **200** - OK * **304** - Not modified ### Code examples #### Example **Request:** ```curl curl -L \ -X GET \ http(s)://HOSTNAME/api/v3/search/commits ``` **Response schema (Status: 200):** * `total_count`: required, integer * `incomplete_results`: required, boolean * `items`: required, array of `Commit Search Result Item`: * `url`: required, string, format: uri * `sha`: required, string * `html_url`: required, string, format: uri * `comments_url`: required, string, format: uri * `commit`: required, object: * `author`: required, object: * `name`: required, string * `email`: required, string * `date`: required, string, format: date-time * `committer`: required, any of: * **null** * **Git User** * `name`: string * `email`: string * `date`: string, format: date-time * `comment_count`: required, integer * `message`: required, string * `tree`: required, object: * `sha`: required, string * `url`: required, string, format: uri * `url`: required, string, format: uri * `verification`: `Verification`: * `verified`: required, boolean * `reason`: required, string * `payload`: required, string or null * `signature`: required, string or null * `verified_at`: required, string or null * `author`: required, any of: * **null** * **Simple User** * `name`: string or null * `email`: string or null * `login`: required, string * `id`: required, integer, format: int64 * `node_id`: required, string * `avatar_url`: required, string, format: uri * `gravatar_id`: required, string or null * `url`: required, string, format: uri * `html_url`: required, string, format: uri * `followers_url`: required, string, format: uri * `following_url`: required, string * `gists_url`: required, string * `starred_url`: required, string * `subscriptions_url`: required, string, format: uri * `organizations_url`: required, string, format: uri * `repos_url`: required, string, format: uri * `events_url`: required, string * `received_events_url`: required, string, format: uri * `type`: required, string * `site_admin`: required, boolean * `starred_at`: string * `user_view_type`: string * `committer`: required, any of: * **null** * **Git User** (see above) * `parents`: required, array of objects: * `url`: string * `html_url`: string * `sha`: string * `repository`: required, `Minimal Repository`: * `id`: required, integer, format: int64 * `node_id`: required, string * `name`: required, string * `full_name`: required, string * `owner`: required, `Simple User` (see above) * `private`: required, boolean * `html_url`: required, string, format: uri * `description`: required, string or null * `fork`: required, boolean * `url`: required, string, format: uri * `archive_url`: required, string * `assignees_url`: required, string * `blobs_url`: required, string * `branches_url`: required, string * `collaborators_url`: required, string * `comments_url`: required, string * `commits_url`: required, string * `compare_url`: required, string * `contents_url`: required, string * `contributors_url`: required, string, format: uri * `deployments_url`: required, string, format: uri * `downloads_url`: required, string, format: uri * `events_url`: required, string, format: uri * `forks_url`: required, string, format: uri * `git_commits_url`: required, string * `git_refs_url`: required, string * `git_tags_url`: required, string * `git_url`: string * `issue_comment_url`: required, string * `issue_events_url`: required, string * `issues_url`: required, string * `keys_url`: required, string * `labels_url`: required, string * `languages_url`: required, string, format: uri * `merges_url`: required, string, format: uri * `milestones_url`: required, string * `notifications_url`: required, string * `pulls_url`: required, string * `releases_url`: required, string * `ssh_url`: string * `stargazers_url`: required, string, format: uri * `statuses_url`: required, string * `subscribers_url`: required, string, format: uri * `subscription_url`: required, string, format: uri * `tags_url`: required, string, format: uri * `teams_url`: required, string, format: uri * `trees_url`: required, string * `clone_url`: string * `mirror_url`: string or null * `hooks_url`: required, string, format: uri * `svn_url`: string * `homepage`: string or null * `language`: string or null * `forks_count`: integer * `stargazers_count`: integer * `watchers_count`: integer * `size`: integer * `default_branch`: string * `open_issues_count`: integer * `is_template`: boolean * `topics`: array of string * `has_issues`: boolean * `has_projects`: boolean * `has_wiki`: boolean * `has_pages`: boolean * `has_downloads`: boolean * `has_discussions`: boolean * `has_pull_requests`: boolean * `pull_request_creation_policy`: string, enum: `all`, `collaborators_only` * `archived`: boolean * `disabled`: boolean * `visibility`: string * `pushed_at`: string or null, format: date-time * `created_at`: string or null, format: date-time * `updated_at`: string or null, format: date-time * `permissions`: object: * `admin`: boolean * `maintain`: boolean * `push`: boolean * `triage`: boolean * `pull`: boolean * `role_name`: string * `temp_clone_token`: string * `delete_branch_on_merge`: boolean * `subscribers_count`: integer * `network_count`: integer * `code_of_conduct`: `Code Of Conduct`: * `key`: required, string * `name`: required, string * `url`: required, string, format: uri * `body`: string * `html_url`: required, string or null, format: uri * `license`: object or null: * `key`: string * `name`: string * `spdx_id`: string * `url`: string or null * `node_id`: string * `forks`: integer * `open_issues`: integer * `watchers`: integer * `allow_forking`: boolean * `web_commit_signoff_required`: boolean * `security_and_analysis`: object or null: * `advanced_security`: object: * `status`: string, enum: `enabled`, `disabled` * `code_security`: object: * `status`: string, enum: `enabled`, `disabled` * `dependabot_security_updates`: object: * `status`: string, enum: `enabled`, `disabled` * `secret_scanning`: object: * `status`: string, enum: `enabled`, `disabled` * `secret_scanning_push_protection`: object: * `status`: string, enum: `enabled`, `disabled` * `secret_scanning_non_provider_patterns`: object: * `status`: string, enum: `enabled`, `disabled` * `custom_properties`: object, additional properties allowed * `score`: required, number * `node_id`: required, string * `text_matches`: array of objects: * `object_url`: string * `object_type`: string or null * `property`: string * `fragment`: string * `matches`: array of objects: * `text`: string * `indices`: array of integer ## Search issues and pull requests ``` GET /search/issues ``` Find issues by state and keyword. This method returns up to 100 results per page. 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 text-match media type. For more details about how to receive highlighted search results, see Text match metadata. For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. q=windows+label:bug+language:python+state:open\&sort=created\&order=asc This query searches for the keyword windows, within any open issue that is labeled as bug. 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 is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity 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 is qualifier, see "Searching only issues or pull requests." ### Parameters #### Headers * **`accept`** (string) Setting to `application/vnd.github+json` is recommended. #### Path and query parameters * **`q`** (string) (required) The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See "Searching issues and pull requests" for a detailed list of qualifiers. * **`sort`** (string) Sorts the results of your query by the number of comments, reactions, reactions-+1, reactions--1, reactions-smile, reactions-thinking\_face, reactions-heart, reactions-tada, or interactions. You can also sort results by how recently the items were created or updated, Default: best match Can be one of: `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, `interactions`, `created`, `updated` * **`order`** (string) Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort. Default: `desc` Can be one of: `desc`, `asc` * **`per_page`** (integer) The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: `30` * **`page`** (integer) The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default: `1` * **`advanced_search`** (string) Set to true to use advanced search. Example: * **`search_type`** (string) The type of search to perform on issues. When not specified, the default is lexical search. semantic — performs a pure semantic (vector) search using embedding-based understanding. hybrid — combines semantic search with lexical search for best results. Semantic and hybrid search require authentication and are rate limited to 10 requests per minute. Only applies to issue searches (/search/issues). Can be one of: `semantic`, `hybrid` ### HTTP response status codes * **200** - OK * **304** - Not modified * **401** - Requires authentication * **403** - Forbidden * **422** - Validation failed, or the endpoint has been spammed. * **503** - Service unavailable ### Code examples #### Example 1: Status Code 200 **Request:** ```curl curl -L \ -X GET \ http(s)://HOSTNAME/api/v3/search/issues ``` **Response schema (Status: 200):** * `total_count`: required, integer * `incomplete_results`: required, boolean * `items`: required, array of `Issue Search Result Item`: * `url`: required, string, format: uri * `repository_url`: required, string, format: uri * `labels_url`: required, string * `comments_url`: required, string, format: uri * `events_url`: required, string, format: uri * `html_url`: required, string, format: uri * `id`: required, integer, format: int64 * `node_id`: required, string * `number`: required, integer * `title`: required, string * `locked`: required, boolean * `active_lock_reason`: string or null * `assignees`: array of `Simple User` or null: * `name`: string or null * `email`: string or null * `login`: required, string * `id`: required, integer, format: int64 * `node_id`: required, string * `avatar_url`: required, string, format: uri * `gravatar_id`: required, string or null * `url`: required, string, format: uri * `html_url`: required, string, format: uri * `followers_url`: required, string, format: uri * `following_url`: required, string * `gists_url`: required, string * `starred_url`: required, string * `subscriptions_url`: required, string, format: uri * `organizations_url`: required, string, format: uri * `repos_url`: required, string, format: uri * `events_url`: required, string * `received_events_url`: required, string, format: uri * `type`: required, string * `site_admin`: required, boolean * `starred_at`: string * `user_view_type`: string * `user`: required, any of: * **null** * **Simple User** (see above) * `labels`: required, array of objects: * `id`: integer, format: int64 * `node_id`: string * `url`: string * `name`: string * `color`: string * `default`: boolean * `description`: string or null * `sub_issues_summary`: `Sub-issues Summary`: * `total`: required, integer * `completed`: required, integer * `percent_completed`: required, integer * `issue_dependencies_summary`: `Issue Dependencies Summary`: * `blocked_by`: required, integer * `blocking`: required, integer * `total_blocked_by`: required, integer * `total_blocking`: required, integer * `issue_field_values`: array of `Issue Field Value`: * `issue_field_id`: required, integer, format: int64 * `issue_field_name`: string * `node_id`: required, string * `data_type`: required, string, enum: `text`, `single_select`, `multi_select`, `number`, `date` * `value`: required, any of: * **string** * **number** * **integer** * `single_select_option`: object or null: * `id`: required, integer, format: int64 * `name`: required, string * `color`: required, string * `multi_select_options`: array of objects or null: * `id`: required, integer, format: int64 * `name`: required, string * `color`: required, string * `state`: required, string * `state_reason`: string or null * `assignee`: required, any of: * **null** * **Simple User** (see above) * `milestone`: required, any of: * **null** * **Milestone** * `url`: required, string, format: uri * `html_url`: required, string, format: uri * `labels_url`: required, string, format: uri * `id`: required, integer * `node_id`: required, string * `number`: required, integer * `state`: required, string, enum: `open`, `closed`, default: `"open"` * `title`: required, string * `description`: required, string or null * `creator`: required, any of: * **null** * **Simple User** (see above) * `open_issues`: required, integer * `closed_issues`: required, integer * `created_at`: required, string, format: date-time * `updated_at`: required, string, format: date-time * `closed_at`: required, string or null, format: date-time * `due_on`: required, string or null, format: date-time * `comments`: required, integer * `created_at`: required, string, format: date-time * `updated_at`: required, string, format: date-time * `closed_at`: required, string or null, format: date-time * `text_matches`: array of objects: * `object_url`: string * `object_type`: string or null * `property`: string * `fragment`: string * `matches`: array of objects: * `text`: string * `indices`: array of integer * `pull_request`: object: * `merged_at`: string or null, format: date-time * `diff_url`: required, string or null, format: uri * `html_url`: required, string or null, format: uri * `patch_url`: required, string or null, format: uri * `url`: required, string or null, format: uri * `body`: string * `score`: required, number * `author_association`: required, string, enum: `COLLABORATOR`, `CONTRIBUTOR`, `FIRST_TIMER`, `FIRST_TIME_CONTRIBUTOR`, `MANNEQUIN`, `MEMBER`, `NONE`, `OWNER` * `draft`: boolean * `repository`: `Repository`: * `id`: required, integer, format: int64 * `node_id`: required, string * `name`: required, string * `full_name`: required, string * `license`: required, any of: * **null** * **License Simple** * `key`: required, string * `name`: required, string * `url`: required, string or null, format: uri * `spdx_id`: required, string or null * `node_id`: required, string * `html_url`: string, format: uri * `forks`: required, integer * `permissions`: object: * `admin`: required, boolean * `pull`: required, boolean * `triage`: boolean * `push`: required, boolean * `maintain`: boolean * `owner`: required, `Simple User` (see above) * `private`: required, boolean, default: `false` * `html_url`: required, string, format: uri * `description`: required, string or null * `fork`: required, boolean * `url`: required, string, format: uri * `archive_url`: required, string * `assignees_url`: required, string * `blobs_url`: required, string * `branches_url`: required, string * `collaborators_url`: required, string * `comments_url`: required, string * `commits_url`: required, string * `compare_url`: required, string * `contents_url`: required, string * `contributors_url`: required, string, format: uri * `deployments_url`: required, string, format: uri * `downloads_url`: required, string, format: uri * `events_url`: required, string, format: uri * `forks_url`: required, string, format: uri * `git_commits_url`: required, string * `git_refs_url`: required, string * `git_tags_url`: required, string * `git_url`: required, string * `issue_comment_url`: required, string * `issue_events_url`: required, string * `issues_url`: required, string * `keys_url`: required, string * `labels_url`: required, string * `languages_url`: required, string, format: uri * `merges_url`: required, string, format: uri * `milestones_url`: required, string * `notifications_url`: required, string * `pulls_url`: required, string * `releases_url`: required, string * `ssh_url`: required, string * `stargazers_url`: required, string, format: uri * `statuses_url`: required, string * `subscribers_url`: required, string, format: uri * `subscription_url`: required, string, format: uri * `tags_url`: required, string, format: uri * `teams_url`: required, string, format: uri * `trees_url`: required, string * `clone_url`: required, string * `mirror_url`: required, string or null, format: uri * `hooks_url`: required, string, format: uri * `svn_url`: required, string, format: uri * `homepage`: required, string or null, format: uri * `language`: required, string or null * `forks_count`: required, integer * `stargazers_count`: required, integer * `watchers_count`: required, integer * `size`: required, integer * `default_branch`: required, string * `open_issues_count`: required, integer * `is_template`: boolean, default: `false` * `topics`: array of string * `has_issues`: required, boolean, default: `true` * `has_projects`: required, boolean, default: `true` * `has_wiki`: required, boolean, default: `true` * `has_pages`: required, boolean * `has_downloads`: required, boolean, default: `true`, deprecated * `has_discussions`: boolean, default: `false` * `has_pull_requests`: boolean, default: `true` * `pull_request_creation_policy`: string, enum: `all`, `collaborators_only` * `archived`: required, boolean, default: `false` * `disabled`: required, boolean * `visibility`: string, default: `"public"` * `pushed_at`: required, string or null, format: date-time * `created_at`: required, string or null, format: date-time * `updated_at`: required, string or null, format: date-time * `allow_rebase_merge`: boolean, default: `true` * `temp_clone_token`: string * `allow_squash_merge`: boolean, default: `true` * `allow_auto_merge`: boolean, default: `false` * `delete_branch_on_merge`: boolean, default: `false` * `allow_update_branch`: boolean, default: `false` * `use_squash_pr_title_as_default`: boolean, default: `false`, deprecated * `squash_merge_commit_title`: string, enum: `PR_TITLE`, `COMMIT_OR_PR_TITLE` * `squash_merge_commit_message`: string, enum: `PR_BODY`, `COMMIT_MESSAGES`, `BLANK` * `merge_commit_title`: string, enum: `PR_TITLE`, `MERGE_MESSAGE` * `merge_commit_message`: string, enum: `PR_BODY`, `PR_TITLE`, `BLANK` * `allow_merge_commit`: boolean, default: `true` * `allow_forking`: boolean * `web_commit_signoff_required`: boolean, default: `false` * `open_issues`: required, integer * `watchers`: required, integer * `master_branch`: string * `starred_at`: string * `anonymous_access_enabled`: boolean * `code_search_index_status`: object: * `lexical_search_ok`: boolean * `lexical_commit_sha`: string * `body_html`: string * `body_text`: string * `timeline_url`: string, format: uri * `type`: `Issue Type`: * `id`: required, integer * `node_id`: required, string * `name`: required, string * `description`: required, string or null * `color`: string or null, enum: `gray`, `blue`, `green`, `yellow`, `orange`, `red`, `pink`, `purple`, `null` * `created_at`: string, format: date-time * `updated_at`: string, format: date-time * `is_enabled`: boolean * `performed_via_github_app`: any of: * **null** * **GitHub app** * `id`: required, integer * `slug`: string * `node_id`: required, string * `client_id`: string * `owner`: required, one of: * **Simple User** (see above) * **Enterprise** * `description`: string or null * `html_url`: required, string, format: uri * `website_url`: string or null, format: uri * `id`: required, integer * `node_id`: required, string * `name`: required, string * `slug`: required, string * `created_at`: required, string or null, format: date-time * `updated_at`: required, string or null, format: date-time * `avatar_url`: required, string, format: uri * `name`: required, string * `description`: required, string or null * `external_url`: required, string, format: uri * `html_url`: required, string, format: uri * `created_at`: required, string, format: date-time * `updated_at`: required, string, format: date-time * `permissions`: required, object, additional properties: string: * `issues`: string * `checks`: string * `metadata`: string * `contents`: string * `deployments`: string * `events`: required, array of string * `installations_count`: integer * `pinned_comment`: any of: * **null** * **Issue Comment** * `id`: required, integer, format: int64 * `node_id`: required, string * `url`: required, string, format: uri * `body`: string * `body_text`: string * `body_html`: string * `html_url`: required, string, format: uri * `user`: required, any of: * **null** * **Simple User** (see above) * `created_at`: required, string, format: date-time * `updated_at`: required, string, format: date-time * `issue_url`: required, string, format: uri * `author_association`: string, enum: `COLLABORATOR`, `CONTRIBUTOR`, `FIRST_TIMER`, `FIRST_TIME_CONTRIBUTOR`, `MANNEQUIN`, `MEMBER`, `NONE`, `OWNER` * `performed_via_github_app`: any of: * **null** * **GitHub app** (see above) * `reactions`: `Reaction Rollup`: * `url`: required, string, format: uri * `total_count`: required, integer * `+1`: required, integer * `-1`: required, integer * `laugh`: required, integer * `confused`: required, integer * `heart`: required, integer * `hooray`: required, integer * `eyes`: required, integer * `rocket`: required, integer * `pin`: any of: * **null** * **Pinned Issue Comment** * `pinned_at`: required, string, format: date-time * `pinned_by`: required, any of: * **null** * **Simple User** (see above) * `minimized`: any of: * **null** * **Minimized Issue Comment** * `reason`: required, string or null * `reactions`: `Reaction Rollup` (see above) * `search_type`: required, string, enum: `lexical`, `semantic`, `hybrid` * `lexical_fallback_reason`: array of string, enum: `no_text_terms`, `quoted_text`, `non_issue_target`, `or_boolean_not_supported`, `no_accessible_repos`, `server_error`, `only_non_semantic_fields_requested`, `service_unavailable` #### Example 2: Status Code 200 **Request:** ```curl curl -L \ -X GET \ http(s)://HOSTNAME/api/v3/search/issues ``` **Response schema (Status: 200):** * `total_count`: required, integer * `incomplete_results`: required, boolean * `items`: required, array of `Issue Search Result Item`: * `url`: required, string, format: uri * `repository_url`: required, string, format: uri * `labels_url`: required, string * `comments_url`: required, string, format: uri * `events_url`: required, string, format: uri * `html_url`: required, string, format: uri * `id`: required, integer, format: int64 * `node_id`: required, string * `number`: required, integer * `title`: required, string * `locked`: required, boolean * `active_lock_reason`: string or null * `assignees`: array of `Simple User` or null: * `name`: string or null * `email`: string or null * `login`: required, string * `id`: required, integer, format: int64 * `node_id`: required, string * `avatar_url`: required, string, format: uri * `gravatar_id`: required, string or null * `url`: required, string, format: uri * `html_url`: required, string, format: uri * `followers_url`: required, string, format: uri * `following_url`: required, string * `gists_url`: required, string * `starred_url`: required, string * `subscriptions_url`: required, string, format: uri * `organizations_url`: required, string, format: uri * `repos_url`: required, string, format: uri * `events_url`: required, string * `received_events_url`: required, string, format: uri * `type`: required, string * `site_admin`: required, boolean * `starred_at`: string * `user_view_type`: string * `user`: required, any of: * **null** * **Simple User** (see above) * `labels`: required, array of objects: * `id`: integer, format: int64 * `node_id`: string * `url`: string * `name`: string * `color`: string * `default`: boolean * `description`: string or null * `sub_issues_summary`: `Sub-issues Summary`: * `total`: required, integer * `completed`: required, integer * `percent_completed`: required, integer * `issue_dependencies_summary`: `Issue Dependencies Summary`: * `blocked_by`: required, integer * `blocking`: required, integer * `total_blocked_by`: required, integer * `total_blocking`: required, integer * `issue_field_values`: array of `Issue Field Value`: * `issue_field_id`: required, integer, format: int64 * `issue_field_name`: string * `node_id`: required, string * `data_type`: required, string, enum: `text`, `single_select`, `multi_select`, `number`, `date` * `value`: required, any of: * **string** * **number** * **integer** * `single_select_option`: object or null: * `id`: required, integer, format: int64 * `name`: required, string * `color`: required, string * `multi_select_options`: array of objects or null: * `id`: required, integer, format: int64 * `name`: required, string * `color`: required, string * `state`: required, string * `state_reason`: string or null * `assignee`: required, any of: * **null** * **Simple User** (see above) * `milestone`: required, any of: * **null** * **Milestone** * `url`: required, string, format: uri * `html_url`: required, string, format: uri * `labels_url`: required, string, format: uri * `id`: required, integer * `node_id`: required, string * `number`: required, integer * `state`: required, string, enum: `open`, `closed`, default: `"open"` * `title`: required, string * `description`: required, string or null * `creator`: required, any of: * **null** * **Simple User** (see above) * `open_issues`: required, integer * `closed_issues`: required, integer * `created_at`: required, string, format: date-time * `updated_at`: required, string, format: date-time * `closed_at`: required, string or null, format: date-time * `due_on`: required, string or null, format: date-time * `comments`: required, integer * `created_at`: required, string, format: date-time * `updated_at`: required, string, format: date-time * `closed_at`: required, string or null, format: date-time * `text_matches`: array of objects: * `object_url`: string * `object_type`: string or null * `property`: string * `fragment`: string * `matches`: array of objects: * `text`: string * `indices`: array of integer * `pull_request`: object: * `merged_at`: string or null, format: date-time * `diff_url`: required, string or null, format: uri * `html_url`: required, string or null, format: uri * `patch_url`: required, string or null, format: uri * `url`: required, string or null, format: uri * `body`: string * `score`: required, number * `author_association`: required, string, enum: `COLLABORATOR`, `CONTRIBUTOR`, `FIRST_TIMER`, `FIRST_TIME_CONTRIBUTOR`, `MANNEQUIN`, `MEMBER`, `NONE`, `OWNER` * `draft`: boolean * `repository`: `Repository`: * `id`: required, integer, format: int64 * `node_id`: required, string * `name`: required, string * `full_name`: required, string * `license`: required, any of: * **null** * **License Simple** * `key`: required, string * `name`: required, string * `url`: required, string or null, format: uri * `spdx_id`: required, string or null * `node_id`: required, string * `html_url`: string, format: uri * `forks`: required, integer * `permissions`: object: * `admin`: required, boolean * `pull`: required, boolean * `triage`: boolean * `push`: required, boolean * `maintain`: boolean * `owner`: required, `Simple User` (see above) * `private`: required, boolean, default: `false` * `html_url`: required, string, format: uri * `description`: required, string or null * `fork`: required, boolean * `url`: required, string, format: uri * `archive_url`: required, string * `assignees_url`: required, string * `blobs_url`: required, string * `branches_url`: required, string * `collaborators_url`: required, string * `comments_url`: required, string * `commits_url`: required, string * `compare_url`: required, string * `contents_url`: required, string * `contributors_url`: required, string, format: uri * `deployments_url`: required, string, format: uri * `downloads_url`: required, string, format: uri * `events_url`: required, string, format: uri * `forks_url`: required, string, format: uri * `git_commits_url`: required, string * `git_refs_url`: required, string * `git_tags_url`: required, string * `git_url`: required, string * `issue_comment_url`: required, string * `issue_events_url`: required, string * `issues_url`: required, string * `keys_url`: required, string * `labels_url`: required, string * `languages_url`: required, string, format: uri * `merges_url`: required, string, format: uri * `milestones_url`: required, string * `notifications_url`: required, string * `pulls_url`: required, string * `releases_url`: required, string * `ssh_url`: required, string * `stargazers_url`: required, string, format: uri * `statuses_url`: required, string * `subscribers_url`: required, string, format: uri * `subscription_url`: required, string, format: uri * `tags_url`: required, string, format: uri * `teams_url`: required, string, format: uri * `trees_url`: required, string * `clone_url`: required, string * `mirror_url`: required, string or null, format: uri * `hooks_url`: required, string, format: uri * `svn_url`: required, string, format: uri * `homepage`: required, string or null, format: uri * `language`: required, string or null * `forks_count`: required, integer * `stargazers_count`: required, integer * `watchers_count`: required, integer * `size`: required, integer * `default_branch`: required, string * `open_issues_count`: required, integer * `is_template`: boolean, default: `false` * `topics`: array of string * `has_issues`: required, boolean, default: `true` * `has_projects`: required, boolean, default: `true` * `has_wiki`: required, boolean, default: `true` * `has_pages`: required, boolean * `has_downloads`: required, boolean, default: `true`, deprecated * `has_discussions`: boolean, default: `false` * `has_pull_requests`: boolean, default: `true` * `pull_request_creation_policy`: string, enum: `all`, `collaborators_only` * `archived`: required, boolean, default: `false` * `disabled`: required, boolean * `visibility`: string, default: `"public"` * `pushed_at`: required, string or null, format: date-time * `created_at`: required, string or null, format: date-time * `updated_at`: required, string or null, format: date-time * `allow_rebase_merge`: boolean, default: `true` * `temp_clone_token`: string * `allow_squash_merge`: boolean, default: `true` * `allow_auto_merge`: boolean, default: `false` * `delete_branch_on_merge`: boolean, default: `false` * `allow_update_branch`: boolean, default: `false` * `use_squash_pr_title_as_default`: boolean, default: `false`, deprecated * `squash_merge_commit_title`: string, enum: `PR_TITLE`, `COMMIT_OR_PR_TITLE` * `squash_merge_commit_message`: string, enum: `PR_BODY`, `COMMIT_MESSAGES`, `BLANK` * `merge_commit_title`: string, enum: `PR_TITLE`, `MERGE_MESSAGE` * `merge_commit_message`: string, enum: `PR_BODY`, `PR_TITLE`, `BLANK` * `allow_merge_commit`: boolean, default: `true` * `allow_forking`: boolean * `web_commit_signoff_required`: boolean, default: `false` * `open_issues`: required, integer * `watchers`: required, integer * `master_branch`: string * `starred_at`: string * `anonymous_access_enabled`: boolean * `code_search_index_status`: object: * `lexical_search_ok`: boolean * `lexical_commit_sha`: string * `body_html`: string * `body_text`: string * `timeline_url`: string, format: uri * `type`: `Issue Type`: * `id`: required, integer * `node_id`: required, string * `name`: required, string * `description`: required, string or null * `color`: string or null, enum: `gray`, `blue`, `green`, `yellow`, `orange`, `red`, `pink`, `purple`, `null` * `created_at`: string, format: date-time * `updated_at`: string, format: date-time * `is_enabled`: boolean * `performed_via_github_app`: any of: * **null** * **GitHub app** * `id`: required, integer * `slug`: string * `node_id`: required, string * `client_id`: string * `owner`: required, one of: * **Simple User** (see above) * **Enterprise** * `description`: string or null * `html_url`: required, string, format: uri * `website_url`: string or null, format: uri * `id`: required, integer * `node_id`: required, string * `name`: required, string * `slug`: required, string * `created_at`: required, string or null, format: date-time * `updated_at`: required, string or null, format: date-time * `avatar_url`: required, string, format: uri * `name`: required, string * `description`: required, string or null * `external_url`: required, string, format: uri * `html_url`: required, string, format: uri * `created_at`: required, string, format: date-time * `updated_at`: required, string, format: date-time * `permissions`: required, object, additional properties: string: * `issues`: string * `checks`: string * `metadata`: string * `contents`: string * `deployments`: string * `events`: required, array of string * `installations_count`: integer * `pinned_comment`: any of: * **null** * **Issue Comment** * `id`: required, integer, format: int64 * `node_id`: required, string * `url`: required, string, format: uri * `body`: string * `body_text`: string * `body_html`: string * `html_url`: required, string, format: uri * `user`: required, any of: * **null** * **Simple User** (see above) * `created_at`: required, string, format: date-time * `updated_at`: required, string, format: date-time * `issue_url`: required, string, format: uri * `author_association`: string, enum: `COLLABORATOR`, `CONTRIBUTOR`, `FIRST_TIMER`, `FIRST_TIME_CONTRIBUTOR`, `MANNEQUIN`, `MEMBER`, `NONE`, `OWNER` * `performed_via_github_app`: any of: * **null** * **GitHub app** (see above) * `reactions`: `Reaction Rollup`: * `url`: required, string, format: uri * `total_count`: required, integer * `+1`: required, integer * `-1`: required, integer * `laugh`: required, integer * `confused`: required, integer * `heart`: required, integer * `hooray`: required, integer * `eyes`: required, integer * `rocket`: required, integer * `pin`: any of: * **null** * **Pinned Issue Comment** * `pinned_at`: required, string, format: date-time * `pinned_by`: required, any of: * **null** * **Simple User** (see above) * `minimized`: any of: * **null** * **Minimized Issue Comment** * `reason`: required, string or null * `reactions`: `Reaction Rollup` (see above) * `search_type`: required, string, enum: `lexical`, `semantic`, `hybrid` * `lexical_fallback_reason`: array of string, enum: `no_text_terms`, `quoted_text`, `non_issue_target`, `or_boolean_not_supported`, `no_accessible_repos`, `server_error`, `only_non_semantic_fields_requested`, `service_unavailable` ## Search labels ``` GET /search/labels ``` Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results per page. When searching for labels, you can get text match metadata for the label name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata. For example, if you want to find labels in the linguist repository that match bug, defect, or enhancement. Your query might look like this: q=bug+defect+enhancement\&repository\_id=64778136 The labels that best match the query appear first in the search results. ### Parameters #### Headers * **`accept`** (string) Setting to `application/vnd.github+json` is recommended. #### Path and query parameters * **`repository_id`** (integer) (required) The id of the repository. * **`q`** (string) (required) The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see Constructing a search query. * **`sort`** (string) Sorts the results of your query by when the label was created or updated. Default: best match Can be one of: `created`, `updated` * **`order`** (string) Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort. Default: `desc` Can be one of: `desc`, `asc` * **`per_page`** (integer) The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: `30` * **`page`** (integer) The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default: `1` ### HTTP response status codes * **200** - OK * **304** - Not modified * **403** - Forbidden * **404** - Resource not found * **422** - Validation failed, or the endpoint has been spammed. ### Code examples #### Example **Request:** ```curl curl -L \ -X GET \ http(s)://HOSTNAME/api/v3/search/labels ``` **Response schema (Status: 200):** * `total_count`: required, integer * `incomplete_results`: required, boolean * `items`: required, array of `Label Search Result Item`: * `id`: required, integer * `node_id`: required, string * `url`: required, string, format: uri * `name`: required, string * `color`: required, string * `default`: required, boolean * `description`: required, string or null * `score`: required, number * `text_matches`: array of objects: * `object_url`: string * `object_type`: string or null * `property`: string * `fragment`: string * `matches`: array of objects: * `text`: string * `indices`: array of integer ## Search repositories ``` GET /search/repositories ``` Find repositories via various criteria. This method returns up to 100 results per page. When searching for repositories, you can get text match metadata for the name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata. For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: q=tetris+language:assembly\&sort=stars\&order=desc This query searches for repositories with the word tetris 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. ### Parameters #### Headers * **`accept`** (string) Setting to `application/vnd.github+json` is recommended. #### Path and query parameters * **`q`** (string) (required) The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See "Searching for repositories" for a detailed list of qualifiers. * **`sort`** (string) Sorts the results of your query by number of stars, forks, or help-wanted-issues or how recently the items were updated. Default: best match Can be one of: `stars`, `forks`, `help-wanted-issues`, `updated` * **`order`** (string) Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort. Default: `desc` Can be one of: `desc`, `asc` * **`per_page`** (integer) The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: `30` * **`page`** (integer) The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default: `1` ### HTTP response status codes * **200** - OK * **304** - Not modified * **422** - Validation failed, or the endpoint has been spammed. * **503** - Service unavailable ### Code examples #### Example **Request:** ```curl curl -L \ -X GET \ http(s)://HOSTNAME/api/v3/search/repositories ``` **Response schema (Status: 200):** * `total_count`: required, integer * `incomplete_results`: required, boolean * `items`: required, array of `Repo Search Result Item`: * `id`: required, integer * `node_id`: required, string * `name`: required, string * `full_name`: required, string * `owner`: required, any of: * **null** * **Simple User** * `name`: string or null * `email`: string or null * `login`: required, string * `id`: required, integer, format: int64 * `node_id`: required, string * `avatar_url`: required, string, format: uri * `gravatar_id`: required, string or null * `url`: required, string, format: uri * `html_url`: required, string, format: uri * `followers_url`: required, string, format: uri * `following_url`: required, string * `gists_url`: required, string * `starred_url`: required, string * `subscriptions_url`: required, string, format: uri * `organizations_url`: required, string, format: uri * `repos_url`: required, string, format: uri * `events_url`: required, string * `received_events_url`: required, string, format: uri * `type`: required, string * `site_admin`: required, boolean * `starred_at`: string * `user_view_type`: string * `private`: required, boolean * `html_url`: required, string, format: uri * `description`: required, string or null * `fork`: required, boolean * `url`: required, string, format: uri * `created_at`: required, string, format: date-time * `updated_at`: required, string, format: date-time * `pushed_at`: required, string, format: date-time * `homepage`: required, string or null, format: uri * `size`: required, integer * `stargazers_count`: required, integer * `watchers_count`: required, integer * `language`: required, string or null * `forks_count`: required, integer * `open_issues_count`: required, integer * `master_branch`: string * `default_branch`: required, string * `score`: required, number * `forks_url`: required, string, format: uri * `keys_url`: required, string * `collaborators_url`: required, string * `teams_url`: required, string, format: uri * `hooks_url`: required, string, format: uri * `issue_events_url`: required, string * `events_url`: required, string, format: uri * `assignees_url`: required, string * `branches_url`: required, string * `tags_url`: required, string, format: uri * `blobs_url`: required, string * `git_tags_url`: required, string * `git_refs_url`: required, string * `trees_url`: required, string * `statuses_url`: required, string * `languages_url`: required, string, format: uri * `stargazers_url`: required, string, format: uri * `contributors_url`: required, string, format: uri * `subscribers_url`: required, string, format: uri * `subscription_url`: required, string, format: uri * `commits_url`: required, string * `git_commits_url`: required, string * `comments_url`: required, string * `issue_comment_url`: required, string * `contents_url`: required, string * `compare_url`: required, string * `merges_url`: required, string, format: uri * `archive_url`: required, string * `downloads_url`: required, string, format: uri * `issues_url`: required, string * `pulls_url`: required, string * `milestones_url`: required, string * `notifications_url`: required, string * `labels_url`: required, string * `releases_url`: required, string * `deployments_url`: required, string, format: uri * `git_url`: required, string * `ssh_url`: required, string * `clone_url`: required, string * `svn_url`: required, string, format: uri * `forks`: required, integer * `open_issues`: required, integer * `watchers`: required, integer * `topics`: array of string * `mirror_url`: required, string or null, format: uri * `has_issues`: required, boolean * `has_projects`: required, boolean * `has_pages`: required, boolean * `has_wiki`: required, boolean * `has_downloads`: required, boolean * `has_discussions`: boolean * `has_pull_requests`: boolean * `pull_request_creation_policy`: string, enum: `all`, `collaborators_only` * `archived`: required, boolean * `disabled`: required, boolean * `visibility`: string * `license`: required, any of: * **null** * **License Simple** * `key`: required, string * `name`: required, string * `url`: required, string or null, format: uri * `spdx_id`: required, string or null * `node_id`: required, string * `html_url`: string, format: uri * `permissions`: object: * `admin`: required, boolean * `maintain`: boolean * `push`: required, boolean * `triage`: boolean * `pull`: required, boolean * `text_matches`: array of objects: * `object_url`: string * `object_type`: string or null * `property`: string * `fragment`: string * `matches`: array of objects: * `text`: string * `indices`: array of integer * `temp_clone_token`: string * `allow_merge_commit`: boolean * `allow_squash_merge`: boolean * `allow_rebase_merge`: boolean * `allow_auto_merge`: boolean * `delete_branch_on_merge`: boolean * `allow_forking`: boolean * `is_template`: boolean * `web_commit_signoff_required`: boolean ## Search topics ``` GET /search/topics ``` Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results per page. See "Searching topics" 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 text-match media type. For more details about how to receive highlighted search results, see Text match metadata. For example, if you want to search for topics related to Ruby that are featured on . Your query might look like this: q=ruby+is:featured This query searches for topics with the keyword ruby 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. ### Parameters #### Headers * **`accept`** (string) Setting to `application/vnd.github+json` is recommended. #### Path and query parameters * **`q`** (string) (required) The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. * **`per_page`** (integer) The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: `30` * **`page`** (integer) The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default: `1` ### HTTP response status codes * **200** - OK * **304** - Not modified ### Code examples #### Example **Request:** ```curl curl -L \ -X GET \ http(s)://HOSTNAME/api/v3/search/topics ``` **Response schema (Status: 200):** * `total_count`: required, integer * `incomplete_results`: required, boolean * `items`: required, array of `Topic Search Result Item`: * `name`: required, string * `display_name`: required, string or null * `short_description`: required, string or null * `description`: required, string or null * `created_by`: required, string or null * `released`: required, string or null * `created_at`: required, string, format: date-time * `updated_at`: required, string, format: date-time * `featured`: required, boolean * `curated`: required, boolean * `score`: required, number * `repository_count`: integer or null * `logo_url`: string or null, format: uri * `text_matches`: array of objects: * `object_url`: string * `object_type`: string or null * `property`: string * `fragment`: string * `matches`: array of objects: * `text`: string * `indices`: array of integer * `related`: array of objects or null: * `topic_relation`: object: * `id`: integer * `name`: string * `topic_id`: integer * `relation_type`: string * `aliases`: array of objects or null: * `topic_relation`: object: * `id`: integer * `name`: string * `topic_id`: integer * `relation_type`: string ## Search users ``` GET /search/users ``` Find users via various criteria. This method returns up to 100 results per page. When searching for users, you can get text match metadata for the issue login, public email, and name fields when you pass the text-match media type. For more details about highlighting search results, see Text match metadata. For more details about how to receive highlighted search results, see Text match metadata. For example, if you're looking for a list of popular users, you might try this query: q=tom+repos:%3E42+followers:%3E1000 This query searches for users with the name tom. 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 "GraphQL Queries." ### Parameters #### Headers * **`accept`** (string) Setting to `application/vnd.github+json` is recommended. #### Path and query parameters * **`q`** (string) (required) The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See "Searching users" for a detailed list of qualifiers. * **`sort`** (string) Sorts the results of your query by number of followers or repositories, or when the person joined GitHub Enterprise Server. Default: best match Can be one of: `followers`, `repositories`, `joined` * **`order`** (string) Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort. Default: `desc` Can be one of: `desc`, `asc` * **`per_page`** (integer) The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: `30` * **`page`** (integer) The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default: `1` ### HTTP response status codes * **200** - OK * **304** - Not modified * **422** - Validation failed, or the endpoint has been spammed. * **503** - Service unavailable ### Code examples #### Example **Request:** ```curl curl -L \ -X GET \ http(s)://HOSTNAME/api/v3/search/users ``` **Response schema (Status: 200):** * `total_count`: required, integer * `incomplete_results`: required, boolean * `items`: required, array of `User Search Result Item`: * `login`: required, string * `id`: required, integer, format: int64 * `node_id`: required, string * `avatar_url`: required, string, format: uri * `gravatar_id`: required, string or null * `url`: required, string, format: uri * `html_url`: required, string, format: uri * `followers_url`: required, string, format: uri * `subscriptions_url`: required, string, format: uri * `organizations_url`: required, string, format: uri * `repos_url`: required, string, format: uri * `received_events_url`: required, string, format: uri * `type`: required, string * `score`: required, number * `following_url`: required, string * `gists_url`: required, string * `starred_url`: required, string * `events_url`: required, string * `public_repos`: integer * `public_gists`: integer * `followers`: integer * `following`: integer * `created_at`: string, format: date-time * `updated_at`: string, format: date-time * `name`: string or null * `bio`: string or null * `email`: string or null, format: email * `location`: string or null * `site_admin`: required, boolean * `hireable`: boolean or null * `text_matches`: array of objects: * `object_url`: string * `object_type`: string or null * `property`: string * `fragment`: string * `matches`: array of objects: * `text`: string * `indices`: array of integer * `blog`: string or null * `company`: string or null * `suspended_at`: string or null, format: date-time * `user_view_type`: string