# Get a check run

From **GitHub v3 REST API**.

`GET /repos/{owner}/{repo}/check-runs/{check_run_id}`

**Note:** The Checks API only looks 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_requests` array.

Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.

## Parameters

### `owner`

- Location: path
- Required: true
- Type: `string`

### `repo`

- Location: path
- Required: true
- Type: `string`

### `check_run_id`

- Location: path
- Required: true
- Type: `integer`

check_run_id parameter

## Responses

### `200`

Response

### `application/json`

- Type: `object`

A check performed on the code of a given code change

```json
{
  "app": {
    "created_at": "2017-07-08T16:18:44-04:00",
    "description": "",
    "events": [
      "push",
      "pull_request"
    ],
    "external_url": "https://example.com",
    "html_url": "https://github.com/apps/octoapp",
    "id": 1,
    "name": "Octocat App",
    "node_id": "MDExOkludGVncmF0aW9uMQ==",
    "owner": {
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "events_url": "https://api.github.com/orgs/github/events",
      "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}",
      "gravatar_id": "",
      "html_url": "https://github.com/octocat",
      "id": 1,
      "login": "github",
      "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "repos_url": "https://api.github.com/orgs/github/repos",
      "site_admin": true,
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "type": "User",
      "url": "https://api.github.com/orgs/github"
    },
    "permissions": {
      "contents": "read",
      "issues": "write",
      "metadata": "read",
      "single_file": "write"
    },
    "slug": "octoapp",
    "updated_at": "2017-07-08T16:18:44-04:00"
  },
  "check_suite": {
    "id": 5
  },
  "completed_at": "2018-05-04T01:14:52Z",
  "conclusion": "neutral",
  "details_url": "https://example.com",
  "external_id": "",
  "head_sha": "ce587453ced02b1526dfb4cb910479d431683101",
  "html_url": "https://github.com/github/hello-world/runs/4",
  "id": 4,
  "name": "mighty_readme",
  "node_id": "MDg6Q2hlY2tSdW40",
  "output": {
    "annotations_count": 2,
    "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations",
    "summary": "There are 0 failures, 2 warnings, and 1 notice.",
    "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.",
    "title": "Mighty Readme report"
  },
  "pull_requests": [
    {
      "base": {
        "ref": "master",
        "repo": {
          "id": 526,
          "name": "hello-world",
          "url": "https://api.github.com/repos/github/hello-world"
        },
        "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f"
      },
      "head": {
        "ref": "say-hello",
        "repo": {
          "id": 526,
          "name": "hello-world",
          "url": "https://api.github.com/repos/github/hello-world"
        },
        "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390"
      },
      "id": 1934,
      "number": 3956,
      "url": "https://api.github.com/repos/github/hello-world/pulls/1"
    }
  ],
  "started_at": "2018-05-04T01:14:52Z",
  "status": "completed",
  "url": "https://api.github.com/repos/github/hello-world/check-runs/4"
}
```

```json
{"description":"A check performed on the code of a given code change","properties":{"app":{"$ref":"#/components/schemas/nullable-integration"},"check_suite":{"nullable":true,"properties":{"id":{"type":"integer"}},"required":["id"],"type":"object"},"completed_at":{"example":"2018-05-04T01:14:52Z","format":"date-time","nullable":true,"type":"string"},"conclusion":{"enum":["success","failure","neutral","cancelled","skipped","timed_out","action_required"],"example":"neutral","nullable":true,"type":"string"},"deployment":{"$ref":"#/components/schemas/deployment-simple"},"details_url":{"example":"https://example.com","nullable":true,"type":"string"},"external_id":{"example":"42","nullable":true,"type":"string"},"head_sha":{"description":"The SHA of the commit that is being checked.","example":"009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d","type":"string"},"html_url":{"example":"https://github.com/github/hello-world/runs/4","nullable":true,"type":"string"},"id":{"description":"The id of the check.","example":21,"type":"integer"},"name":{"description":"The name of the check.","example":"test-coverage","type":"string"},"node_id":{"example":"MDg6Q2hlY2tSdW40","type":"string"},"output":{"properties":{"annotations_count":{"type":"integer"},"annotations_url":{"format":"uri","type":"string"},"summary":{"nullable":true,"type":"string"},"text":{"nullable":true,"type":"string"},"title":{"nullable":true,"type":"string"}},"required":["title","summary","text","annotations_count","annotations_url"],"type":"object"},"pull_requests":{"items":{"$ref":"#/components/schemas/pull-request-minimal"},"type":"array"},"started_at":{"example":"2018-05-04T01:14:52Z","format":"date-time","nullable":true,"type":"string"},"status":{"description":"The phase of the lifecycle that the check is currently in.","enum":["queued","in_progress","completed"],"example":"queued","type":"string"},"url":{"example":"https://api.github.com/repos/github/hello-world/check-runs/4","type":"string"}},"required":["id","node_id","head_sha","name","url","html_url","details_url","status","conclusion","started_at","completed_at","external_id","check_suite","output","app","pull_requests"],"title":"CheckRun","type":"object"}
```

## Request examples

### cURL

```shell
curl --request GET \
  --url {protocol}://{hostname}/api/v3/repos/{owner}/{repo}/check-runs/{check_run_id}
```