GitHub: List check suites for a Git reference

← Checks operations · Get started

Operation github.checks_list_suites_for_ref

Provider route: GET /repos/{owner}/{repo}/commits/{ref}/check-suites. 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"]["checksListSuitesForRef"]>[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.checksListSuitesForRef(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_suites_for_ref(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.ref	string	Required within parent
query	object	Optional	Additional keys: not allowed
query.app_id	integer	Optional
query.check_name	string	Optional
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_suites	array	Required within parent
check_suites[]	Model	Each item	Expand Get a check suite — 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 suite — response body

Schemas

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

Get a check suite — response body

Field	Type	Presence	Description and constraints
$	object	Root	A suite of checks performed on the code of a given code change
after	JSON	Required within parent
after (anyOf 1)	string	Alternative
after (anyOf 2)	null	Alternative
app	Model	Required within parent	Expand Get an app — response body
before	JSON	Required within parent
before (anyOf 1)	string	Alternative
before (anyOf 2)	null	Alternative
check_runs_url	string	Required within parent
conclusion	JSON	Required within parent
conclusion (anyOf 1)	string	Alternative	Known values: success, failure, neutral, cancelled, skipped, timed_out, action_required, startup_failure, stale
conclusion (anyOf 2)	null	Alternative
created_at	JSON	Required within parent
created_at (anyOf 1)	string	Alternative	Format: date-time
created_at (anyOf 2)	null	Alternative
head_branch	JSON	Required within parent
head_branch (anyOf 1)	string	Alternative
head_branch (anyOf 2)	null	Alternative
head_commit	Model	Required within parent	Expand Get a check suite — response body — head commit
head_sha	string	Required within parent	The SHA of the head commit that is being checked.
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	Format: int64
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
latest_check_runs_count	JSON	Required within parent
latest_check_runs_count (anyOf 1)	integer	Alternative
latest_check_runs_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
node_id	string	Required within parent
pull_requests	JSON	Required within parent
pull_requests (anyOf 1)	array	Alternative
pull_requests (anyOf 1)[]	Model	Each item	Expand Get a check run — response body — pull requests item
pull_requests (anyOf 2)	null	Alternative
repository	Model	Required within parent	Expand Transfer a repository — response body
rerequestable	boolean	Optional
runs_rerequestable	boolean	Optional
status	JSON	Required within parent
status (anyOf 1)	string	Alternative	The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites. Known values: queued, in_progress, completed, waiting, requested, pending
status (anyOf 2)	null	Alternative
updated_at	JSON	Required within parent
updated_at (anyOf 1)	string	Alternative	Format: date-time
updated_at (anyOf 2)	null	Alternative
url	JSON	Required within parent
url (anyOf 1)	string	Alternative
url (anyOf 2)	null	Alternative

Referenced models: Get an app — response body, Transfer a repository — response body, Get a check run — response body — pull requests item, Get a check suite — response body — head commit

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

Get a check run — response body — pull requests item

Field	Type	Presence	Description and constraints
$	object	Root
base	object	Required within parent
base.ref	string	Required within parent
base.repo	object	Required within parent
base.repo.id	JSON	Required within parent
base.repo.id (anyOf 1)	integer	Alternative	Format: int64
base.repo.id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
base.repo.name	string	Required within parent
base.repo.url	string	Required within parent
base.sha	string	Required within parent
head	object	Required within parent
head.ref	string	Required within parent
head.repo	object	Required within parent
head.repo.id	JSON	Required within parent
head.repo.id (anyOf 1)	integer	Alternative	Format: int64
head.repo.id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
head.repo.name	string	Required within parent
head.repo.url	string	Required within parent
head.sha	string	Required within parent
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	Format: int64
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
number	JSON	Required within parent
number (anyOf 1)	integer	Alternative
number (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
url	string	Required within parent

Get a code of conduct — response body

Field	Type	Presence	Description and constraints
$	object	Root	Code Of Conduct
body	string	Optional
html_url	JSON	Required within parent
html_url (anyOf 1)	string	Alternative	Format: uri
html_url (anyOf 2)	null	Alternative
key	string	Required within parent
name	string	Required within parent
url	string	Required within parent	Format: uri

Policy, approvals and errors

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