GitHub API (unofficial showcase)
GET/repos/{owner}/{repo}/commits/{ref}/check-runs

List check runs for a Git reference

Lists check runs for a Git reference in a repository. Set ref to a commit SHA, branch name, or tag name, and use check_name, status, filter, or app_id to narrow the results; use page and per_page to paginate the results. If the reference has more than 1,000 check suites, results are limited to the 1,000 most recent suites; use the check-suite endpoints to retrieve additional runs.

9 parameters
ownerstringrequired
The account owner of the repository; the name is not case-sensitive.
repostringrequired
The repository name without the `.git` extension; the name is not case-sensitive.
refstringrequired
The commit reference: a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`).
check_namestringoptional
Filter check runs by their name.
statusstringoptional
Filter check runs by status: queued, in_progress, or completed.
Allowed:queuedin_progresscompleted
filterstringoptional
Filter runs by their completion time: latest or all. Defaults to latest when omitted.
Allowed:latestallDefault:latest
per_pageintegeroptional
Number of results per page, up to 100. Defaults to 30 when omitted.
Default:30
pageintegeroptional
Page number of the results to fetch. Defaults to 1 when omitted.
Default:1
app_idintegeroptional
Filter check runs by the GitHub App ID.

1 status code
200Returns an object containing `total_count` and an array of `check_runs` with check run details.
total_countintegerrequired
check_runsarray<CheckRun>required

Error handling

The ref path parameter must be a commit SHA, branch name, or tag name; use heads/BRANCH_NAME or tags/TAG_NAME for branches and tags. status must be queued, in_progress, or completed, and filter must be latest or all. For a private repository, your OAuth app token or classic personal access token needs the repo scope.