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.”

API method documentation

Parameters

Query Parameters

required

string

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 Constructing a search query. See “Searching issues and pull requests” for a detailed list of qualifiers.

sort

string

Allowed values: comments reactions reactions-+1 reactions--1 reactions-smile reactions-thinking_face reactions-heart reactions-tada interactions created updated

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

order

string

default: desc

Allowed values: desc asc

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.

per_page

integer

default: 30

The number of results per page (max 100). For more information, see “Using pagination in the REST API.”

page

integer

default: 1

The page number of the results to fetch. For more information, see “Using pagination in the REST API.”

advanced_search

string

Set to true to use advanced search. Example: http://api.github.com/search/issues?q={query}&advanced_search=true

search_type

string

Allowed values: semantic hybrid

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).

Responses

200

Response

application/json

object

total_count

required

integer

incomplete_results

required

boolean

items

required

Array<object>

Issue Search Result Item

Issue Search Result Item

object

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

required

integer format: int64

node_id

required

string

number

required

integer

title

required

string

locked

required

boolean

active_lock_reason

string

nullable

assignees

Array<object>

nullable

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

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

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

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

labels

required

Array<object>

object

integer format: int64

node_id

string

url

string

name

string

color

string

default

boolean

description

string

nullable

sub_issues_summary

Sub-issues Summary

object

total

required

integer

completed

required

integer

percent_completed

required

integer

issue_dependencies_summary

Issue Dependencies Summary

object

blocked_by

required

integer

blocking

required

integer

total_blocked_by

required

integer

total_blocking

required

integer

issue_field_values

Array<object>

Issue Field Value

A value assigned to an issue field

object

issue_field_id

required

Unique identifier for the issue field.

integer format: int64

issue_field_name

The human-readable name of the issue field.

string

node_id

required

string

data_type

required

The data type of the issue field

string

Allowed values: text single_select multi_select number date

value

required

Any of:

string

single_select_option

Details about the selected option (only present for single_select fields)

object

required

Unique identifier for the option.

integer format: int64

name

required

The name of the option

string

color

required

The color of the option

string

multi_select_options

Details about the selected options

Array<object>

nullable

object

required

Unique identifier for the option.

integer format: int64

name

required

The name of the option

string

color

required

The color of the option

string

state

required

string

state_reason

string

nullable

assignee

required

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

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

milestone

required

Milestone

A collection of related issues and pull requests.

object

url

required

string format: uri

html_url

required

string format: uri

labels_url

required

string format: uri

required

integer

node_id

required

string

number

required

The number of the milestone.

integer

state

required

The state of the milestone.

string

default: open

Allowed values: open closed

title

required

The title of the milestone.

string

description

required

string

nullable

creator

required

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

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

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 format: date-time

nullable

due_on

required

string format: date-time

nullable

comments

required

integer

created_at

required

string format: date-time

updated_at

required

string format: date-time

closed_at

required

string format: date-time

nullable

text_matches

Search Result Text Matches

Array<object>

object

object_url

string

object_type

string

nullable

property

string

fragment

string

matches

Array<object>

object

text

string

indices

Array<integer>

pull_request

object

merged_at

string format: date-time

nullable

diff_url

required

string format: uri

nullable

html_url

required

string format: uri

nullable

patch_url

required

string format: uri

nullable

url

required

string format: uri

nullable

body

string

score

required

number

author_association

required

author_association

How the author is associated with the repository.

string

Allowed values: COLLABORATOR CONTRIBUTOR FIRST_TIMER FIRST_TIME_CONTRIBUTOR MANNEQUIN MEMBER NONE OWNER

draft

boolean

repository

Repository

A repository on GitHub.

object

required

Unique identifier of the repository

integer format: int64

node_id

required

string

name

required

The name of the repository.

string

full_name

required

string

license

required

License Simple

License Simple

object

key

required

string

name

required

string

url

required

string format: uri

nullable

spdx_id

required

string

nullable

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

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

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

Whether the repository is private or public.

boolean

html_url

required

string format: uri

description

required

string

nullable

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 format: uri

nullable

hooks_url

required

string format: uri

svn_url

required

string format: uri

homepage

required

string format: uri

nullable

language

required

string

nullable

forks_count

required

integer

stargazers_count

required

integer

watchers_count

required

integer

size

required

The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.

integer

default_branch

required

The default branch of the repository.

string

open_issues_count

required

integer

is_template

Whether this repository acts as a template that can be used to generate new repositories.

boolean

topics

Array<string>

has_issues

required

Whether issues are enabled.

boolean

default: true

has_projects

required

Whether projects are enabled.

boolean

default: true

has_wiki

required

Whether the wiki is enabled.

boolean

default: true

has_pages

required

boolean

has_downloads

required

Whether downloads are enabled.

boolean

default: true

has_discussions

Whether discussions are enabled.

boolean

has_pull_requests

Whether pull requests are enabled.

boolean

default: true

pull_request_creation_policy

The policy controlling who can create pull requests: all or collaborators_only.

string

Allowed values: all collaborators_only

archived

required

Whether the repository is archived.

boolean

disabled

required

Returns whether or not this repository disabled.

boolean

visibility

The repository visibility: public, private, or internal.

string

default: public

pushed_at

required

string format: date-time

nullable

created_at

required

string format: date-time

nullable

updated_at

required

string format: date-time

nullable

allow_rebase_merge

Whether to allow rebase merges for pull requests.

boolean

default: true

temp_clone_token

string

allow_squash_merge

Whether to allow squash merges for pull requests.

boolean

default: true

allow_auto_merge

Whether to allow Auto-merge to be used on pull requests.

boolean

delete_branch_on_merge

Whether to delete head branches when pull requests are merged

boolean

allow_update_branch

Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.

boolean

use_squash_pr_title_as_default

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

boolean

squash_merge_commit_title

The default value for a squash merge commit title:

PR_TITLE - default to the pull request’s title.
COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).

string

Allowed values: PR_TITLE COMMIT_OR_PR_TITLE

squash_merge_commit_message

The default value for a squash merge commit message:

PR_BODY - default to the pull request’s body.
COMMIT_MESSAGES - default to the branch’s commit messages.
BLANK - default to a blank commit message.

string

Allowed values: PR_BODY COMMIT_MESSAGES BLANK

merge_commit_title

The default value for a merge commit title.

PR_TITLE - default to the pull request’s title.
MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).

string

Allowed values: PR_TITLE MERGE_MESSAGE

merge_commit_message

The default value for a merge commit message.

PR_TITLE - default to the pull request’s title.
PR_BODY - default to the pull request’s body.
BLANK - default to a blank commit message.

string

Allowed values: PR_BODY PR_TITLE BLANK

allow_merge_commit

Whether to allow merge commits for pull requests.

boolean

default: true

allow_forking

Whether to allow forking this repo

boolean

web_commit_signoff_required

Whether to require contributors to sign off on web-based commits

boolean

open_issues

required

integer

watchers

required

integer

master_branch

string

starred_at

string

anonymous_access_enabled

Whether anonymous git access is enabled for this repository

boolean

code_search_index_status

The status of the code search index for this repository

object

lexical_search_ok

boolean

lexical_commit_sha

string

body_html

string

body_text

string

timeline_url

string format: uri

type

Issue Type

The type assigned to the issue. This is only present for issues in repositories where issue types are supported.

object

required

The unique identifier of the issue type.

integer

node_id

required

The node identifier of the issue type.

string

name

required

The name of the issue type.

string

description

required

The description of the issue type.

string

nullable

color

The color of the issue type.

string

nullable

Allowed values: gray blue green yellow orange red pink purple

created_at

The time the issue type created.

string format: date-time

updated_at

The time the issue type last updated.

string format: date-time

is_enabled

The enabled state of the issue type.

boolean

performed_via_github_app

GitHub app

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

object

required

Unique identifier of the GitHub app

integer

slug

The slug name of the GitHub app

string

node_id

required

string

client_id

string

owner

required

One of:

Simple User
Enterprise

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

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

name

required

The name of the GitHub app

string

description

required

string

nullable

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

The set of permissions for the GitHub app

object

issues

string

checks

string

metadata

string

contents

string

deployments

string

key

additional properties

string

events

required

The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.

Array<string>

installations_count

The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.

integer

pinned_comment

Issue Comment

Comments provide a way for people to collaborate on an issue.

object

required

Unique identifier of the issue comment

integer format: int64

node_id

required

string

url

required

URL for the issue comment

string format: uri

body

Contents of the issue comment

string

body_text

string

body_html

string

html_url

required

string format: uri

user

required

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

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

created_at

required

string format: date-time

updated_at

required

string format: date-time

issue_url

required

string format: uri

author_association

author_association

How the author is associated with the repository.

string

Allowed values: COLLABORATOR CONTRIBUTOR FIRST_TIMER FIRST_TIME_CONTRIBUTOR MANNEQUIN MEMBER NONE OWNER

performed_via_github_app

GitHub app

object

required

Unique identifier of the GitHub app

integer

slug

The slug name of the GitHub app

string

node_id

required

string

client_id

string

owner

required

One of:

Simple User
Enterprise

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

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

name

required

The name of the GitHub app

string

description

required

string

nullable

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

The set of permissions for the GitHub app

object

issues

string

checks

string

metadata

string

contents

string

deployments

string

key

additional properties

string

events

required

The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.

Array<string>

installations_count

The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.

integer

reactions

Reaction Rollup

object

url

required

string format: uri

total_count

required

integer

required

integer

-1

required

integer

laugh

required

integer

confused

required

integer

heart

required

integer

hooray

required

integer

eyes

required

integer

rocket

required

integer

pin

Pinned Issue Comment

Context around who pinned an issue comment and when it was pinned.

object

pinned_at

required

string format: date-time

pinned_by

required

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

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

minimized

Minimized Issue Comment

Details about why an issue comment was minimized.

object

reason

required

The reason the comment was minimized.

string

nullable

reactions

Reaction Rollup

object

url

required

string format: uri

total_count

required

integer

required

integer

-1

required

integer

laugh

required

integer

confused

required

integer

heart

required

integer

hooray

required

integer

eyes

required

integer

rocket

required

integer

search_type

required

The type of search that was performed. Possible values are lexical, semantic, or hybrid.

string

Allowed values: lexical semantic hybrid

lexical_fallback_reason

When a semantic or hybrid search falls back to lexical search, this field contains the reasons for the fallback. Only present when a fallback occurred.

Array<string>

Allowed values: no_text_terms quoted_text non_issue_target or_boolean_not_supported no_accessible_repos server_error only_non_semantic_fields_requested service_unavailable

Examples

Hybrid search response

{
  "total_count": 280,
  "incomplete_results": false,
  "search_type": "hybrid",
  "items": [
    {
      "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132",
      "repository_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit",
      "labels_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name}",
      "comments_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments",
      "events_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events",
      "html_url": "https://github.com/batterseapower/pinyin-toolkit/issues/132",
      "id": 35802,
      "node_id": "MDU6SXNzdWUzNTgwMg==",
      "number": 132,
      "title": "Line Number Indexes Beyond 20 Not Displayed",
      "type": {
        "id": 1,
        "node_id": "IT_kwDNJr9H",
        "name": "Bug",
        "description": "An unexpected problem or behavior",
        "color": "red",
        "created_at": "2023-10-09T13:30:49Z",
        "updated_at": "2024-05-30T18:20:53Z",
        "is_enabled": true
      },
      "user": {
        "login": "Nick3C",
        "id": 90254,
        "node_id": "MDQ6VXNlcjkwMjU0",
        "avatar_url": "https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png",
        "gravatar_id": "",
        "url": "https://api.github.com/users/Nick3C",
        "html_url": "https://github.com/Nick3C",
        "followers_url": "https://api.github.com/users/Nick3C/followers",
        "following_url": "https://api.github.com/users/Nick3C/following{/other_user}",
        "gists_url": "https://api.github.com/users/Nick3C/gists{/gist_id}",
        "starred_url": "https://api.github.com/users/Nick3C/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/Nick3C/subscriptions",
        "organizations_url": "https://api.github.com/users/Nick3C/orgs",
        "repos_url": "https://api.github.com/users/Nick3C/repos",
        "events_url": "https://api.github.com/users/Nick3C/events{/privacy}",
        "received_events_url": "https://api.github.com/users/Nick3C/received_events",
        "type": "User",
        "site_admin": true
      },
      "labels": [
        {
          "id": 4,
          "node_id": "MDU6TGFiZWw0",
          "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug",
          "name": "bug",
          "color": "ff0000"
        }
      ],
      "state": "open",
      "assignee": null,
      "milestone": {
        "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
        "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
        "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
        "id": 1002604,
        "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
        "number": 1,
        "state": "open",
        "title": "v1.0",
        "description": "Tracking milestone for version 1.0",
        "creator": {
          "login": "octocat",
          "id": 1,
          "node_id": "MDQ6VXNlcjE=",
          "avatar_url": "https://github.com/images/error/octocat_happy.gif",
          "gravatar_id": "",
          "url": "https://api.github.com/users/octocat",
          "html_url": "https://github.com/octocat",
          "followers_url": "https://api.github.com/users/octocat/followers",
          "following_url": "https://api.github.com/users/octocat/following{/other_user}",
          "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
          "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
          "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
          "organizations_url": "https://api.github.com/users/octocat/orgs",
          "repos_url": "https://api.github.com/users/octocat/repos",
          "events_url": "https://api.github.com/users/octocat/events{/privacy}",
          "received_events_url": "https://api.github.com/users/octocat/received_events",
          "type": "User",
          "site_admin": false
        },
        "open_issues": 4,
        "closed_issues": 8,
        "created_at": "2011-04-10T20:09:31Z",
        "updated_at": "2014-03-03T18:58:10Z",
        "closed_at": "2013-02-12T13:22:01Z",
        "due_on": "2012-10-09T23:39:01Z"
      },
      "comments": 15,
      "created_at": "2009-07-12T20:10:41Z",
      "updated_at": "2009-07-19T09:23:43Z",
      "closed_at": null,
      "pull_request": {
        "url": "https://api/github.com/repos/octocat/Hello-World/pull/1347",
        "html_url": "https://github.com/octocat/Hello-World/pull/1347",
        "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
        "patch_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347"
      },
      "body": "...",
      "score": 1,
      "locked": true,
      "author_association": "COLLABORATOR",
      "state_reason": "completed"
    }
  ]
}

Hybrid search with lexical fallback

When a hybrid or semantic search falls back to lexical, the response includes search_type set to “lexical” and lexical_fallback_reason listing the reasons. Items are the same shape as the default example.

{
  "total_count": 280,
  "incomplete_results": false,
  "search_type": "lexical",
  "lexical_fallback_reason": [
    "quoted_text"
  ],
  "items": [
    "..."
  ]
}

304

Not modified

401

Requires authentication

application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

403

Forbidden

application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

422

Validation failed, or the endpoint has been spammed.

application/json

Validation Error

Validation Error

object

message

required

string

documentation_url

required

string

errors

Array<object>

object

resource

string

field

string

message

string

code

required

string

index

integer

value

One of:

string

nullable

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "errors": [
    {
      "resource": "example",
      "field": "example",
      "message": "example",
      "code": "example",
      "index": 1,
      "value": [
        "example"
      ]
    }
  ]
}

503

Service unavailable

application/json

object

code

string

message

string

documentation_url

string

Example ^generated

{
  "code": "example",
  "message": "example",
  "documentation_url": "example"
}

Search issues and pull requests

Parameters

Query Parameters

Responses

200

Examples

304

401

Example generated

403

Example generated

422

Example generated

503

Example generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated