List check run 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.

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

Source: github-v3-rest.json
Revision: f5f067c1e6f6
Active snapshot: 85e53e3d0d65

Request

Path Parameters

owner string required
repo string required
check_run_id integer required: check_run_id parameter

Query Parameters

per_page integer optional: Results per page (max 100)
page integer optional: Page number of the results to fetch.

Responses

application/json array[Check Annotation object]

Response

Headers

Link string

Example:

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

items Check Annotation object

Check Annotation

annotation_level string

requirednullable

Example: warning

blob_href string

required

end_column integer

requirednullable

Example: 10

end_line integer

required

Example: 2

message string

requirednullable

Example: Check your spelling for 'banaas'.

path string

required

Example: README.md

raw_details string

requirednullable

Example: Do you mean 'bananas' or 'banana'?

start_column integer

requirednullable

Example: 5

start_line integer

required

Example: 2

title string

requirednullable

Example: Spell Checker

Response Example: 200 application/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"
  }
]

Request configuration

This OpenAPI document does not declare an authentication scheme. Check the API provider's documentation before sending credentials; Manja cannot infer or validate an undocumented scheme.

Common bearer example: Authorization: Bearer YOUR_ACCESS_TOKEN

hostname

Self-hosted Enterprise Server or Enterprise Cloud hostname

protocol

Self-hosted Enterprise Server or Enterprise Cloud protocol

owner *

repo *

check_run_id *

check_run_id parameter

per_page

Results per page (max 100)

page

Page number of the results to fetch.

Request Sample: Shell / cURL

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