GitHub: List check runs in a check suite

← Checks operations · Get started

Operation github.checks_list_for_suite

Provider route: GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs. 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"]["checksListForSuite"]>[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.checksListForSuite(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_for_suite(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_suite_id	integer	Required within parent
query	object	Optional	Additional keys: not allowed
query.check_name	string	Optional
query.status	string	Optional	One of: queued, in_progress, completed
query.filter	string	Optional	Default: latest One of: latest, all
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
$	object	Root
check_runs	array	Required within parent
check_runs[]	Model	Each item	Expand Get a check run — response body
total_count	JSON	Required within parent
total_count (anyOf 1)	integer	Alternative
total_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get a check run — response body

Schemas

3 more schemas are linked from the tables above, on the schema pages.

Get a check run — response body

Field	Type	Presence	Description and constraints
$	object	Root	A check performed on the code of a given code change
app	Model	Required within parent	Expand Get an app — response body
check_suite	JSON	Required within parent
check_suite (anyOf 1)	object	Alternative
check_suite (anyOf 1).id	JSON	Required within parent
check_suite (anyOf 1).id (anyOf 1)	integer	Alternative
check_suite (anyOf 1).id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
check_suite (anyOf 2)	null	Alternative
completed_at	JSON	Required within parent
completed_at (anyOf 1)	string	Alternative	Format: date-time
completed_at (anyOf 2)	null	Alternative
conclusion	JSON	Required within parent
conclusion (anyOf 1)	string	Alternative	Known values: success, failure, neutral, cancelled, skipped, timed_out, action_required
conclusion (anyOf 2)	null	Alternative
deployment	Model	Optional	Expand Get a check run — response body — deployment
details_url	JSON	Required within parent
details_url (anyOf 1)	string	Alternative
details_url (anyOf 2)	null	Alternative
external_id	JSON	Required within parent
external_id (anyOf 1)	string	Alternative
external_id (anyOf 2)	null	Alternative
head_sha	string	Required within parent	The SHA of the commit that is being checked.
html_url	JSON	Required within parent
html_url (anyOf 1)	string	Alternative
html_url (anyOf 2)	null	Alternative
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	The id of the check. Format: int64
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
name	string	Required within parent	The name of the check.
node_id	string	Required within parent
output	object	Required within parent
output.annotations_count	JSON	Required within parent
output.annotations_count (anyOf 1)	integer	Alternative
output.annotations_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
output.annotations_url	string	Required within parent	Format: uri
output.summary	JSON	Required within parent
output.summary (anyOf 1)	string	Alternative
output.summary (anyOf 2)	null	Alternative
output.text	JSON	Required within parent
output.text (anyOf 1)	string	Alternative
output.text (anyOf 2)	null	Alternative
output.title	JSON	Required within parent
output.title (anyOf 1)	string	Alternative
output.title (anyOf 2)	null	Alternative
pull_requests	array	Required within parent	Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check.
pull_requests[]	Model	Each item	Expand Get a check run — response body — pull requests item
started_at	JSON	Required within parent
started_at (anyOf 1)	string	Alternative	Format: date-time
started_at (anyOf 2)	null	Alternative
status	string	Required within parent	The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs. Known values: queued, in_progress, completed, waiting, requested, pending
url	string	Required within parent

Referenced models: Get a check run — response body — deployment, Get an app — response body, Get a check run — response body — pull requests item

Get a check run — response body — deployment

Field	Type	Presence	Description and constraints
$	object	Root	A deployment created as the result of an Actions check run from a workflow that references an environment
created_at	string	Required within parent	Format: date-time
description	JSON	Required within parent
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
environment	string	Required within parent	Name for the target deployment environment.
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	Unique identifier of the deployment
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
node_id	string	Required within parent
original_environment	string	Optional
performed_via_github_app	Model	Optional	Expand Get an app — response body
production_environment	boolean	Optional	Specifies if the given environment is one that end-users directly interact with. Default: false.
repository_url	string	Required within parent	Format: uri
statuses_url	string	Required within parent	Format: uri
task	string	Required within parent	Parameter to specify a task to execute
transient_environment	boolean	Optional	Specifies if the given environment is will no longer exist at some point in the future. Default: false.
updated_at	string	Required within parent	Format: date-time
url	string	Required within parent	Format: uri

Referenced models: Get an app — response body

Get an app — response body

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
$ (anyOf 1).client_id	string	Optional
$ (anyOf 1).created_at	string	Required within parent	Format: date-time
$ (anyOf 1).description	JSON	Required within parent
$ (anyOf 1).description (anyOf 1)	string	Alternative
$ (anyOf 1).description (anyOf 2)	null	Alternative
$ (anyOf 1).events	array	Required within parent	The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.
$ (anyOf 1).events[]	string	Each item
$ (anyOf 1).external_url	string	Required within parent	Format: uri
$ (anyOf 1).html_url	string	Required within parent	Format: uri
$ (anyOf 1).id	JSON	Required within parent
$ (anyOf 1).id (anyOf 1)	integer	Alternative	Unique identifier of the GitHub app
$ (anyOf 1).id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).installations_count	JSON	Optional
$ (anyOf 1).installations_count (anyOf 1)	integer	Alternative	The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
$ (anyOf 1).installations_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).name	string	Required within parent	The name of the GitHub app
$ (anyOf 1).node_id	string	Required within parent
$ (anyOf 1).owner	JSON	Required within parent
$ (anyOf 1).owner (anyOf 1)	Model	Alternative	Expand List users — response body — item
$ (anyOf 1).owner (anyOf 2)	Model	Alternative	Expand Get an app — response body — client id, created at, description, events, external url, html url, id, installations count, name, node id, owner, permissions, slug, updated at owner Enterprise
$ (anyOf 1).permissions	object	Required within parent	The set of permissions for the GitHub app Additional keys: see wildcard field
$ (anyOf 1).permissions.checks	string	Optional
$ (anyOf 1).permissions.contents	string	Optional
$ (anyOf 1).permissions.deployments	string	Optional
$ (anyOf 1).permissions.issues	string	Optional
$ (anyOf 1).permissions.metadata	string	Optional
$ (anyOf 1).permissions.*	string	Additional keys
$ (anyOf 1).slug	string	Optional	The slug name of the GitHub app
$ (anyOf 1).updated_at	string	Required within parent	Format: date-time
$ (anyOf 2)	null	Alternative

Referenced models: Get an app — response body — client id, created at, description, events, external url, html url, id, installations count, name, node id, owner, permissions, slug, updated at owner Enterprise, List users — response body — item

Policy, approvals and errors

SDK function policy ID: github.checks_list_for_suite. Catalog operation: checks/list-for-suite. 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