Search

/search/issues

Search issues

Find issues by state and keyword. (This method returns up to 100 results per page.)

The q search term can also contain any combination of the supported issue search qualifiers as described by the in-browser issue search documentation and search syntax documentation:

type With this qualifier you can restrict the search to issues (issue) or pull request (pr) only.
in Qualifies which fields are searched. With this qualifier you can restrict the search to just the title (title), body (body), comments (comment), or any combination of these.
author Finds issues or pull requests created by a certain user.
assignee Finds issues or pull requests that are assigned to a certain user.
mentions Finds issues or pull requests that mention a certain user.
commenter Finds issues or pull requests that a certain user commented on.
involves Finds issues or pull requests that were either created by a certain user, assigned to that user, mention that user, or were commented on by that user.
team For organizations you’re a member of, finds issues or pull requests that @mention a team within the organization.
state Filter issues or pull requests based on whether they’re open or closed.
labels Filters issues or pull requests based on their labels.
no Filters items missing certain metadata, such as label, milestone, or assignee
language Searches for issues or pull requests within repositories that match a certain language.
is Searches for items within repositories that match a certain state, such as open, closed, or merged
created or updated Filters issues or pull requests based on date of creation, or when they were last updated.
merged Filters pull requests based on the date when they were merged.
status Filters pull requests based on the commit status.
head or base Filters pull requests based on the branch that they came from or that they are modifying.
closed Filters issues or pull requests based on the date when they were closed.
comments Filters issues or pull requests based on the quantity of comments.
user or repo Limits searches to a specific user or repository.

If you know the specific SHA hash of a commit, you can use also use it to search for pull requests that contain that SHA. Note that the SHA syntax must be at least seven characters.

GET

Request

Name	Description	Example	Type	Default
Query parameters
order	The sort order if `sort` parameter is provided. One of `asc` or `desc`.		string?	desc
q	The search terms.	windows+label:bug+language:python+state:open	string?
sort	The sort field. Can be `comments`, `created`, or `updated`. Default: results are sorted by best match.		string?
Headers

Responses

Code	Description	Headers	Body
200			application/json \| example { "total_count": 280, "incomplete_results": false, "items": [{ "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", "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, "number": 132, "title": "Line Number Indexes Beyond 20 Not Displayed", "user": { "login": "Nick3C", "id": 90254, "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" }, "labels": [{ "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug", "name": "bug", "color": "ff0000" }], "state": "open", "assignee": null, "milestone": null, "comments": 15, "created_at": "2009-07-12T20:10:41Z", "updated_at": "2009-07-19T09:23:43Z", "closed_at": null, "pull_request": { "html_url": null, "diff_url": null, "patch_url": null }, "body": "...", "score": 1.3859273 }] } { "total_count": 280, "incomplete_results": false, "items": [{ "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", "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, "number": 132, "title": "Line Number Indexes Beyond 20 Not Displayed", "user": { "login": "Nick3C", "id": 90254, "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" }, "labels": [{ "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug", "name": "bug", "color": "ff0000" }], "state": "open", "assignee": null, "milestone": null, "comments": 15, "created_at": "2009-07-12T20:10:41Z", "updated_at": "2009-07-19T09:23:43Z", "closed_at": null, "pull_request": { "html_url": null, "diff_url": null, "patch_url": null }, "body": "...", "score": 1.3859273 }] }

Request URL Request Headers

Response Code

Response Headers

Response | Preview