GitHub tools
The 12 GitHub operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- List repositoriesGETLists the repositories the account can reach: its own, those where it is a collaborator and those of its organizations. Each item has owner.login and name, which are the owner and repo the other tools ask for. Paginate with page and per_page: a page with fewer items than per_page is the last one.
- Search issuesGETSearches 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.
- List issuesGETLists the issues of a repository, newest first. Pull requests come in the list too, marked with a pull_request key. Paginate with page and per_page: a page with fewer items than per_page is the last one.
- Get issueGETReturns an issue, with title, body, state, labels, assignees and milestone. An issue moved to another repository answers 301 with its new location.
- Create issuePOSTCreates an issue in a repository and returns it, with its number. Labels, assignees, milestone and type are silently dropped when the account has no push access to the repository. Notifies the watchers of the repository.
- Update issuePATCHChanges an issue and returns it. Only the fields sent change. To close it, send state closed with a state_reason. Labels and assignees replace the current ones, and an empty list clears them.
- List issue commentsGETLists the comments of an issue or of a pull request, oldest first. The review comments on the code of a pull request are not included. Paginate with page and per_page: a page with fewer items than per_page is the last one.
- Create issue commentPOSTAdds a comment to an issue or to a pull request and returns it. Notifies the participants.
- List pull requestsGETLists the pull requests of a repository, newest first. Paginate with page and per_page: a page with fewer items than per_page is the last one.
- Get pull requestGETReturns a pull request, with its branches, head.sha, mergeable and mergeable_state, the number of commits and changed files, and whether it was merged. mergeable may come null while GitHub computes it: call again after a few seconds.
- Create pull requestPOSTOpens a pull request from the head branch into the base branch and returns it, with its number. Send title, or issue to turn an existing issue into the pull request. Notifies the watchers of the repository.
- Merge pull requestPUTMerges a pull request into its base branch and returns merged and the sha of the new commit. Answers 405 when the pull request cannot be merged, and 409 when sha no longer matches its head. Repositories that merge through a merge queue do not accept it.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
