agent-tasks

List tasks

Changed on

[!NOTE] This endpoint is in public preview and is subject to change.

Returns a list of tasks for the authenticated user

Fine-grained access tokens for "List tasks"

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

The fine-grained token must have the following permission set:

  • "Agent tasks" repository permissions (read)

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

get/agents/tasks

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/agents/tasks
  • Auth: none declared

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.

sincestring date-time

Only show tasks updated at or after this time (ISO 8601 timestamp)

Response

Tasks retrieved successfully

total_active_countinteger

Total count of active (non-archived) tasks

total_archived_countinteger

Total count of archived tasks

Changes