Skip to content

List a check run's annotations in the order they were reported: path, start_line, end_line, start_column, end_column, annotation_level (notice, warning or failure), message, title and raw_details.

GET/repos/{owner}/{name}/check-runs/{id}/annotations
  • Authentication: Optional. Public data can be read without a token; send one to see what is private.
  • MCP tool: workflow with action check_run_annotations, and the same inputs
  • Scope: An access token needs checks:read.
Name Type Required Description
owner string Yes The workspace that owns the repository.
name string Yes The repository’s name.
id string Yes The check run’s id: cr_…, or a g1t Actions job’s job_…
curl https://api.g1t.sh/repos/flagon-io/hello/check-runs/cr_01kq4b7c8d9e0f1g2h3j4k5m6n/annotations \
-H "Authorization: Bearer $G1T_TOKEN"

A successful request answers 200 with:

[
{
"path": "src/parse.rs",
"start_line": 42,
"end_line": 42,
"start_column": 9,
"end_column": 14,
"annotation_level": "warning",
"message": "unused variable: `depth`",
"title": "unused_variables",
"raw_details": "#[warn(unused_variables)] on by default"
}
]

A failed request answers with one of these statuses and a body like {"error": {"code": "not_found", "message": "Repository not found."}}. See errors.

Status Code When
401 unauthenticated A token is required, or the one sent is not valid.
403 forbidden The token is valid but not allowed to do this, such as a member-only change or an agent token outside its repository.
404 not_found It does not exist, or you cannot see it.
422 invalid The input is not valid. message says which field and why.