GitHub: List tasks for an automation in a repository

← Agent automations operations · Get started

Operation github.agent_automations_list_repo_automation_tasks

Provider route: GET /agents/repos/{owner}/{repo}/automations/{automation_id}/tasks. 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["agentAutomations"]["agentAutomationsListRepoAutomationTasks"]>[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.agentAutomations.agentAutomationsListRepoAutomationTasks(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.agent_automations.agent_automations_list_repo_automation_tasks(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.automation_id	string	Required within parent
query	object	Optional	Additional keys: not allowed
query.per_page	integer	Optional	Default: 30 Maximum: 100 Minimum: 1
query.page	integer	Optional	Default: 1 Minimum: 1
query.sort	string	Optional	Default: updated_at One of: updated_at, created_at
query.direction	string	Optional	Default: desc One of: asc, desc
query.state	string	Optional
query.is_archived	boolean	Optional	Default: false

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	A page of tasks created by an automation.
tasks	array	Required within parent	Tasks created by the automation.
tasks[]	object	Each item
tasks[].archived_at	JSON	Optional
tasks[].archived_at (anyOf 1)	string	Alternative	Timestamp when the task was archived, null if not archived Format: date-time
tasks[].archived_at (anyOf 2)	null	Alternative
tasks[].artifacts	array	Optional	Resources created by this task (PRs, branches, etc.)
tasks[].artifacts[]	Model	Each item	Expand Start a task — response body — artifacts item
tasks[].clients	array	Optional	Known client products that created or participated in this task, independent of its executing agents. Omitted when no client identity is known.
tasks[].clients[]	object	Each item
tasks[].clients[].creator	boolean	Required within parent	True only when the service has explicit evidence this client created the containing session or task. False does not imply the original client is known.
tasks[].clients[].integration_id	string	Required within parent	Server-resolved integration identity for the client product.
tasks[].clients[].slug	string	Required within parent	Stable client product identifier, not an agent or host identifier. Clients must tolerate unknown future slugs.
tasks[].created_at	string	Required within parent	Timestamp when the task was created Format: date-time
tasks[].creator	JSON	Optional	The entity who created this task
tasks[].creator (anyOf 1)	object	Alternative	A GitHub user
tasks[].creator (anyOf 1).id	JSON	Optional
tasks[].creator (anyOf 1).id (anyOf 1)	integer	Alternative	The unique identifier of the user Format: int64
tasks[].creator (anyOf 1).id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tasks[].creator_type	string	Optional	Type of the task creator Known values: user, organization
tasks[].custom_agent	object	Optional	Custom agent metadata associated with this task
tasks[].custom_agent.id	string	Optional	The custom agent’s filename without the extension - for example, `performance-optimizer` for a `.github/agents/performance-optimizer.agent.md` custom agent.
tasks[].html_url	string	Optional	Web URL for this task
tasks[].id	string	Required within parent	Unique task identifier
tasks[].name	string	Optional	Human-readable name derived from the task prompt
tasks[].owner	object	Optional	The owner of the repository
tasks[].owner.id	JSON	Optional
tasks[].owner.id (anyOf 1)	integer	Alternative	The unique identifier of the user Format: int64
tasks[].owner.id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tasks[].repository	object	Optional	The repository this task belongs to
tasks[].repository.id	JSON	Optional
tasks[].repository.id (anyOf 1)	integer	Alternative	The unique identifier of the repository Format: int64
tasks[].repository.id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tasks[].session_count	JSON	Optional
tasks[].session_count (anyOf 1)	integer	Alternative	Number of sessions in this task Format: int32
tasks[].session_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tasks[].state	string	Required within parent	Current state of the task, derived from its most recent session Known values: queued, in_progress, completed, failed, idle, waiting_for_user, timed_out, cancelled
tasks[].updated_at	string	Optional	Timestamp of the most recent update Format: date-time
tasks[].url	string	Optional	API URL for this task
tasks[].user_collaborators	array	Optional	User objects of collaborators on this task
tasks[].user_collaborators[]	object	Each item	A GitHub user
tasks[].user_collaborators[].id	JSON	Optional
tasks[].user_collaborators[].id (anyOf 1)	integer	Alternative	The unique identifier of the user Format: int64
tasks[].user_collaborators[].id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Start a task — response body — artifacts item

Schemas

Start a task — response body — artifacts item

Field	Type	Presence	Description and constraints
$	object	Root	A resource generated by the task
data	JSON	Required within parent	Resource data (shape depends on type)
data (anyOf 1)	object	Alternative	A GitHub resource (pull request, issue, etc.)
data (anyOf 1).global_id	string	Optional	GraphQL global ID
data (anyOf 1).id	JSON	Required within parent
data (anyOf 1).id (anyOf 1)	integer	Alternative	GitHub resource ID Format: int64
data (anyOf 1).id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
data (anyOf 2)	object	Alternative	A Git branch reference
data (anyOf 2).base_ref	string	Required within parent	Base branch name
data (anyOf 2).head_ref	string	Required within parent	Head branch name
provider	string	Required within parent	Provider namespace Known values: github
type	string	Required within parent	Type of artifact. Available Values: `pull`, `branch`. Known values: pull, branch

Policy, approvals and errors

SDK function policy ID: github.agent_automations_list_repo_automation_tasks. Catalog operation: agent-automations/list-repo-automation-tasks. 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