GitHub: List check run annotations

GitHub checks.checksListAnnotations: arguments, response, policy and SDK examples.

Operation github.checks_list_annotations

Provider route: GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["checks"]["checksListAnnotations"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.checks.checksListAnnotations(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.checks.checks_list_annotations(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.owner`	string	Required within parent
`path.repo`	string	Required within parent
`path.check_run_id`	integer	Required within parent	Format: int64
`query`	object	Optional	Additional keys: not allowed
`query.per_page`	integer	Optional	Default: 30
`query.page`	integer	Optional	Default: 1

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	array	Root
`$[]`	Model	Each item	Expand List check run annotations — response body — item

Referenced models: List check run annotations — response body — item

Schemas

List check run annotations — response body — item

Field	Type	Presence	Description and constraints
`$`	object	Root	Check Annotation
`annotation_level`	JSON	Required within parent
`annotation_level (anyOf 1)`	string	Alternative
`annotation_level (anyOf 2)`	null	Alternative
`blob_href`	string	Required within parent
`end_column`	JSON	Required within parent
`end_column (anyOf 1)`	JSON	Alternative
`end_column (anyOf 1) (anyOf 1)`	integer	Alternative
`end_column (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`end_column (anyOf 2)`	null	Alternative
`end_line`	JSON	Required within parent
`end_line (anyOf 1)`	integer	Alternative
`end_line (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`message`	JSON	Required within parent
`message (anyOf 1)`	string	Alternative
`message (anyOf 2)`	null	Alternative
`path`	string	Required within parent
`raw_details`	JSON	Required within parent
`raw_details (anyOf 1)`	string	Alternative
`raw_details (anyOf 2)`	null	Alternative
`start_column`	JSON	Required within parent
`start_column (anyOf 1)`	JSON	Alternative
`start_column (anyOf 1) (anyOf 1)`	integer	Alternative
`start_column (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`start_column (anyOf 2)`	null	Alternative
`start_line`	JSON	Required within parent
`start_line (anyOf 1)`	integer	Alternative
`start_line (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`title`	JSON	Required within parent
`title (anyOf 1)`	string	Alternative
`title (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: github.checks_list_annotations. Catalog operation: checks/list-annotations. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source

Report an issue with this page