GET /agents/repos/{owner}/{repo}/tasks

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

Returns a list of tasks for a specific repository

Fine-grained access tokens for "List tasks for repository"

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

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

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

Servers

Path parameters

Name Type Required Description
repo String Yes

The name of the repository. The name is not case sensitive.

owner String Yes

The account owner of the repository. The name is not case sensitive.

Query parameters

Name Type Required Description
page Integer No

The page number of the results to fetch.

Default value: 1

direction String No

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

Valid values:

  • "desc"
  • "asc"

Default value: "desc"

creator_id[] Array No

Filter tasks by creator user ID. Accepts one or more user IDs.

per_page Integer No

The number of results per page (max 100).

Default value: 30

sort String No

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

Valid values:

  • "updated_at"
  • "created_at"

Default value: "updated_at"

since String No

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

state String No

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_archived Boolean No

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

Default value: false

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.