List check run annotations

GET

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

Lists annotations for a check run using the annotation id.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.

API method documentation

Parameters

Path Parameters

owner

required

string

The account owner of the repository. The name is not case sensitive.

repo

required

string

The name of the repository without the .git extension. The name is not case sensitive.

check_run_id

required

integer

The unique identifier of the check run.

Query Parameters

per_page

integer

default: 30

The number of results per page (max 100). For more information, see “Using pagination in the REST API.”

page

integer

default: 1

The page number of the results to fetch. For more information, see “Using pagination in the REST API.”

Responses

200

Response

Media type application/json

Array<object>

Check Annotation

Check Annotation

object

path

required

string

start_line

required

integer

end_line

required

integer

start_column

required

integer

nullable

end_column

required

integer

nullable

annotation_level

required

string

nullable

title

required

string

nullable

message

required

string

nullable

raw_details

required

string

nullable

blob_href

required

string

Examples

Example default

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

Headers

Link

string

Example

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