provider agent-tasks GET /agents/tasks
@utdk/github /agents/tasks
List tasks
> [!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: * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) 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.
per_page query
The number of results per page (max 100).
integer
page query
The page number of the results to fetch.
integer
sort query
The field to sort results by. Can be `updated_at` or `created_at`.
enum: updated_at, created_at
direction query
The direction to sort results. Can be `asc` or `desc`.
enum: asc, desc
state query
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`.
string
is_archived query
Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`.
boolean
since query
Only show tasks updated at or after this time (ISO 8601 timestamp)
string

Try it

Authentication
Configure credentials for GitHub v3 REST API
agentTasks.listTasks
GET/agents/tasks
> [!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: * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) 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.

The number of results per page (max 100).

The page number of the results to fetch.

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

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

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`.

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

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

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import github from '@utdk/github';

await github.agentTasks.listTasks({
  "per_page": 30,
  "page": 1,
  "sort": "updated_at",
  "direction": "desc",
  "is_archived": false
})