apicheats.dev github/llms.txt Raw .md
GET

GET /repos/{owner}/{repo}/commits/{ref}/check-runs — GitHub API

GitHub token (required); https://api.github.com

GitHub API

List check runs for a Git reference

Base URL
https://api.github.com
Auth
Authorization: Bearer <GITHUB_API_KEY>
Last verified
2026-10-20 · upstream hash matched
Actions Try in browser→
Agents: curl -H "Accept: text/markdown" this URL
→ 367 tokens · Vary: Accept

Critical gotchas

GitHub recommends an Accept: application/vnd.github+json header and an explicit X-GitHub-Api-Version header.

Fine-grained tokens only authorize repositories and permissions selected when the token is created.

cURL

curl -X GET 'https://api.github.com/repos/example-owner/example-repo/commits/example-ref/check-runs?check_name=example-check-name&status=queued&filter=latest&per_page=30&page=1&app_id=10' \  -H "Authorization: Bearer $GITHUB_TOKEN" \  -H 'Accept: application/vnd.github+json' \  -H 'X-GitHub-Api-Version: 2026-03-10'

Parameters

Name In Type Required Description
owner path string Yes The account owner of the repository. The name is not case sensitive.
repo path string Yes The name of the repository without the `.git` extension. The name is not case sensitive.
ref path string Yes The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.
check_name query string No Returns check runs with the specified `name`.
status query string No Returns check runs with the specified `status`.
filter query string No Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs.
per_page query integer No The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
page query integer No The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
app_id query integer No query parameter app_id.

Response 200 OK

{
  "total_count": 0,
  "check_runs": [
    {
      "id": 21,
      "head_sha": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d",
      "node_id": "MDg6Q2hlY2tSdW40",
      "external_id": "42",
      "url": "https://api.github.com/repos/github/hello-world/check-runs/4",
      "html_url": "https://github.com/github/hello-world/runs/4",
      "details_url": "https://example.com",
      "status": "queued",
      "conclusion": "neutral",
      "started_at": "2018-05-04T01:14:52Z",
      "completed_at": "2018-05-04T01:14:52Z",
      "output": {
        "title": "string",
        "summary": "string",
        "text": "string",
        "annotations_count": 0,
        "annotations_url": "https://example.com"
      },
      "name": "test-coverage",
      "check_suite": {
        "id": 0
      },
      "app": {
        "id": 37,
        "slug": "probot-owners",
        "node_id": "MDExOkludGVncmF0aW9uMQ==",
        "client_id": "\"Iv1.25b5d1e65ffc4022\"",
        "owner": {
          "name": "string",
          "email": "string",
          "login": "octocat",
          "id": 1,
          "node_id": "MDQ6VXNlcjE=",
          "avatar_url": "https://github.com/images/error/octocat_happy.gif",
          "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
          "url": "https://api.github.com/users/octocat",
          "html_url": "https://github.com/octocat",
          "followers_url": "https://api.github.com/users/octocat/followers",
          "following_url": "https://api.github.com/users/octocat/following{/other_user}",
          "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
          "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
          "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
          "organizations_url": "https://api.github.com/users/octocat/orgs",
          "repos_url": "https://api.github.com/users/octocat/repos",
          "events_url": "https://api.github.com/users/octocat/events{/privacy}",
          "received_events_url": "https://api.github.com/users/octocat/received_events",
          "type": "User",
          "site_admin": true,
          "starred_at": "\"2020-07-09T00:17:55Z\"",
          "user_view_type": "public"
        },
        "name": "Probot Owners",
        "description": "The description of the app.",
        "external_url": "https://example.com",
        "html_url": "https://github.com/apps/super-ci",
        "created_at": "2017-07-08T16:18:44-04:00",
        "updated_at": "2017-07-08T16:18:44-04:00",
        "permissions": {
          "issues": "read",
          "deployments": "write"
        },
        "events": [
          "label",
          "deployment"
        ],
        "installations_count": 5
      },
      "pull_requests": [
        {
          "id": 0,
          "number": 0,
          "url": "string",
          "head": {
            "ref": "[recursive or deeply nested schema]",
            "sha": "[recursive or deeply nested schema]",
            "repo": "[recursive or deeply nested schema]"
          },
          "base": {
            "ref": "[recursive or deeply nested schema]",
            "sha": "[recursive or deeply nested schema]",
            "repo": "[recursive or deeply nested schema]"
          }
        }
      ],
      "deployment": {
        "url": "https://api.github.com/repos/octocat/example/deployments/1",
        "id": 42,
        "node_id": "MDEwOkRlcGxveW1lbnQx",
        "task": "deploy",
        "original_environment": "staging",
        "environment": "production",
        "description": "Deploy request from hubot",
        "created_at": "2012-07-20T01:19:13Z",
        "updated_at": "2012-07-20T01:19:13Z",
        "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses",
        "repository_url": "https://api.github.com/repos/octocat/example",
        "transient_environment": true,
        "production_environment": true,
        "performed_via_github_app": {
          "id": 37,
          "slug": "probot-owners",
          "node_id": "MDExOkludGVncmF0aW9uMQ==",
          "client_id": "\"Iv1.25b5d1e65ffc4022\"",
          "owner": {
            "name": "[recursive or deeply nested schema]",
            "email": "[recursive or deeply nested schema]",
            "login": "[recursive or deeply nested schema]",
            "id": "[recursive or deeply nested schema]",
            "node_id": "[recursive or deeply nested schema]",
            "avatar_url": "[recursive or deeply nested schema]",
            "gravatar_id": "[recursive or deeply nested schema]",
            "url": "[recursive or deeply nested schema]",
            "html_url": "[recursive or deeply nested schema]",
            "followers_url": "[recursive or deeply nested schema]",
            "following_url": "[recursive or deeply nested schema]",
            "gists_url": "[recursive or deeply nested schema]",
            "starred_url": "[recursive or deeply nested schema]",
            "subscriptions_url": "[recursive or deeply nested schema]",
            "organizations_url": "[recursive or deeply nested schema]",
            "repos_url": "[recursive or deeply nested schema]",
            "events_url": "[recursive or deeply nested schema]",
            "received_events_url": "[recursive or deeply nested schema]",
            "type": "[recursive or deeply nested schema]",
            "site_admin": "[recursive or deeply nested schema]",
            "starred_at": "[recursive or deeply nested schema]",
            "user_view_type": "[recursive or deeply nested schema]"
          },
          "name": "Probot Owners",
          "description": "The description of the app.",
          "external_url": "https://example.com",
          "html_url": "https://github.com/apps/super-ci",
          "created_at": "2017-07-08T16:18:44-04:00",
          "updated_at": "2017-07-08T16:18:44-04:00",
          "permissions": {
            "issues": "read",
            "deployments": "write"
          },
          "events": [
            "label",
            "deployment"
          ],
          "installations_count": 5
        }
      }
    }
  ]
}
Get a free GitHub API key → sponsored

Affiliate link - we may earn a commission, at no extra cost to you.