GET /repos/{owner}/{repo}/commits/{ref}/check-runs
Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name.
[!NOTE] The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty
pull_requestsarray.
If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the List check suites for a Git reference endpoint and provide the check_suite_id parameter to the List check runs in a check suite endpoint.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Servers
- https://api.github.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
repo |
String | Yes |
The name of the repository without the |
ref |
String | Yes |
The commit reference. Can be a commit SHA, branch name ( |
owner |
String | Yes |
The account owner of the repository. The name is not case sensitive. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
page |
Integer | No |
The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default value: 1 |
filter |
String | No |
Filters check runs by their Possible values:
Default value: "latest" |
per_page |
Integer | No |
The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default value: 30 |
status |
String | No |
Returns check runs with the specified Possible values:
|
app_id |
Integer | No | |
check_name |
String | No |
Returns check runs with the specified |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.