agent-automations

List tasks for an automation

Changed on

Returns a list of tasks triggered by the specified automation.

User-owned automation history is available only to its creator, while repository-owned automation history is available to anyone with read access to the repository. Deleted and unlisted tasks are excluded. Tasks produced by private-session agents are excluded unless the caller created the task, is a task collaborator, or the task is shared.

Fine-grained access tokens for "List tasks for an automation"

This endpoint works with the following fine-grained token types:

The fine-grained token must have one of the following permission sets for each repository accessed by this request:

  • "Agent tasks" repository permissions (read)
  • "Contents" repository permissions (read)

The required permission set depends on each repository's Automation permission configuration.

GitHub App installation access tokens are not supported for this endpoint.

get/agents/automations/{automation_id}/tasks

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/agents/automations/{automation_id}/tasks
  • Auth: none declared

Path parameters

automation_idstring required

The unique identifier of the automation.

Query parameters

per_pageinteger

The number of results per page (max 100).

pageinteger

The page number of the results to fetch.

sort'updated_at' | 'created_at'

The field to sort results by. Can be updated_at or created_at.

direction'asc' | 'desc'

The direction to sort results. Can be asc or desc.

statestring

Comma-separated list of task states to filter by. Can be any combination of: queued, in_progress, completed, failed, idle, waiting_for_user, timed_out, cancelled.

is_archivedboolean

Filter by archived status. When true, returns only archived tasks. When false or omitted, returns only non-archived tasks. Defaults to false.

Response

Tasks retrieved successfully

Changes