# List check run annotations

From **GitHub v3 REST API**.

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

Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run 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

### `per_page`

- Location: query
- Required: false
- Type: `integer`
- Default: `30`

Results per page (max 100)

### `page`

- Location: query
- Required: false
- Type: `integer`
- Default: `1`

Page number of the results to fetch.

## Responses

### `200`

Response

#### Headers

##### `Link`

- Type: `string`

- Example: `<https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; rel="last"`

### `application/json`

- Type: `array`

```json
[
  {
    "annotation_level": "warning",
    "blob_href": "https://api.github.com/repos/github/rest-api-description/git/blobs/abc",
    "end_column": 10,
    "end_line": 2,
    "message": "Check your spelling for 'banaas'.",
    "path": "README.md",
    "raw_details": "Do you mean 'bananas' or 'banana'?",
    "start_column": 5,
    "start_line": 2,
    "title": "Spell Checker"
  }
]
```

```json
{"items":{"$ref":"#/components/schemas/check-annotation"},"type":"array"}
```

## Request examples

### cURL

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