GitHub: List jobs for a workflow run attempt

GitHub actions.actionsListJobsForWorkflowRunAttempt: arguments, response, policy and SDK examples.

Operation github.actions_list_jobs_for_workflow_run_attempt

Provider route: GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs. 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["actions"]["actionsListJobsForWorkflowRunAttempt"]>[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.actions.actionsListJobsForWorkflowRunAttempt(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.actions.actions_list_jobs_for_workflow_run_attempt(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.run_id`	integer	Required within parent
`path.attempt_number`	integer	Required within parent
`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
`$`	object	Root
`jobs`	array	Required within parent
`jobs[]`	Model	Each item	Expand Get a job for a workflow 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 job for a workflow run — response body

Schemas

Get a job for a workflow run — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Information of a job execution in a workflow run
`check_run_url`	string	Required within parent
`completed_at`	JSON	Required within parent
`completed_at (anyOf 1)`	string	Alternative	The time that the job finished, in ISO 8601 format. Format: date-time
`completed_at (anyOf 2)`	null	Alternative
`conclusion`	JSON	Required within parent
`conclusion (anyOf 1)`	string	Alternative	The outcome of the job. Known values: success, failure, neutral, cancelled, skipped, timed_out, action_required
`conclusion (anyOf 2)`	null	Alternative
`created_at`	string	Required within parent	The time that the job created, in ISO 8601 format. Format: date-time
`head_branch`	JSON	Required within parent
`head_branch (anyOf 1)`	string	Alternative	The name of the current branch.
`head_branch (anyOf 2)`	null	Alternative
`head_sha`	string	Required within parent	The SHA of the commit that is being run.
`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 job. Format: int64
`id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`labels`	array	Required within parent	Labels for the workflow job. Specified by the "runs_on" attribute in the action's workflow file.
`labels[]`	string	Each item
`name`	string	Required within parent	The name of the job.
`node_id`	string	Required within parent
`run_attempt`	JSON	Optional
`run_attempt (anyOf 1)`	integer	Alternative	Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.
`run_attempt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`run_id`	JSON	Required within parent
`run_id (anyOf 1)`	integer	Alternative	The id of the associated workflow run. Format: int64
`run_id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`run_url`	string	Required within parent
`runner_group_id`	JSON	Required within parent
`runner_group_id (anyOf 1)`	JSON	Alternative
`runner_group_id (anyOf 1) (anyOf 1)`	integer	Alternative	The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
`runner_group_id (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`runner_group_id (anyOf 2)`	null	Alternative
`runner_group_name`	JSON	Required within parent
`runner_group_name (anyOf 1)`	string	Alternative	The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
`runner_group_name (anyOf 2)`	null	Alternative
`runner_id`	JSON	Required within parent
`runner_id (anyOf 1)`	JSON	Alternative
`runner_id (anyOf 1) (anyOf 1)`	integer	Alternative	The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
`runner_id (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`runner_id (anyOf 2)`	null	Alternative
`runner_name`	JSON	Required within parent
`runner_name (anyOf 1)`	string	Alternative	The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
`runner_name (anyOf 2)`	null	Alternative
`started_at`	string	Required within parent	The time that the job started, in ISO 8601 format. Format: date-time
`status`	string	Required within parent	The phase of the lifecycle that the job is currently in. Known values: queued, in_progress, completed, waiting, requested, pending
`steps`	array	Optional	Steps in this job.
`steps[]`	object	Each item
`steps[].completed_at`	JSON	Optional
`steps[].completed_at (anyOf 1)`	string	Alternative	The time that the job finished, in ISO 8601 format. Format: date-time
`steps[].completed_at (anyOf 2)`	null	Alternative
`steps[].conclusion`	JSON	Required within parent
`steps[].conclusion (anyOf 1)`	string	Alternative	The outcome of the job.
`steps[].conclusion (anyOf 2)`	null	Alternative
`steps[].name`	string	Required within parent	The name of the job.
`steps[].number`	JSON	Required within parent
`steps[].number (anyOf 1)`	integer	Alternative
`steps[].number (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`steps[].started_at`	JSON	Optional
`steps[].started_at (anyOf 1)`	string	Alternative	The time that the step started, in ISO 8601 format. Format: date-time
`steps[].started_at (anyOf 2)`	null	Alternative
`steps[].status`	string	Required within parent	The phase of the lifecycle that the job is currently in. Known values: queued, in_progress, completed
`url`	string	Required within parent
`workflow_name`	JSON	Required within parent
`workflow_name (anyOf 1)`	string	Alternative	The name of the workflow.
`workflow_name (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: github.actions_list_jobs_for_workflow_run_attempt. Catalog operation: actions/list-jobs-for-workflow-run-attempt. 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