Search issues with the GitHub API

Searches issues and pull requests in every repository the account can see, with the GitHub search syntax in q. Returns total_count and items, up to 1,000 results per search; paginate with page and per_page. Each item has number, and repository_url ends with the owner and repo of the item.

Identifier
github_search_issues

The request

POST https://connect.reportei.com/api/tools/github_search_issues/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "q": "<q>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
qstringYesKeywords and qualifiers, such as repo:owner/name is:issue is:open label:bug, assignee:@me or author:login. With a token of a GitHub App, include is:issue or is:pull-request: mixing both in one search answers 422.
sortstringNoSort field. Without it, the results come by best match.Values: comments, reactions, reactions-+1, reactions--1, reactions-smile, reactions-thinking_face, reactions-heart, reactions-tada, interactions, created, updated
orderstringNoSort order, only used with sort. The default is desc.Values: desc, asc
advanced_searchstringNoSend true to use advanced search, which accepts AND, OR and parentheses in q.
search_typestringNoSearches issues by meaning instead of exact words: semantic alone, or hybrid with keywords. Limited to 10 searches per minute. Without it, the search is by keywords.Values: semantic, hybrid
per_pageintegerNoResults per page, up to 100. The default is 30.
pageintegerNoPage number, starting at 1.

Supported connections

Your customer connects their GitHub account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/github, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/github_search_issues. It becomes your agent's tool definition with no conversion.

Other GitHub tools

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.