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
- Fine-grained personal access tokens
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.
Servers
- https://api.github.com
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 Valid values:
Default value: "desc" |
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 Valid values:
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: |
is_archived |
Boolean | No |
Filter by archived status. When Default value: false |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.