Skip to main content
GET
/
tasks
List Tasks
const options = {method: 'GET', headers: {'X-Browser-Use-API-Key': '<api-key>'}};

fetch('https://api.browser-use.com/api/v2/tasks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "llm": "<string>",
      "task": "<string>",
      "status": "created",
      "createdAt": "2023-11-07T05:31:56Z",
      "startedAt": "2023-11-07T05:31:56Z",
      "finishedAt": "2023-11-07T05:31:56Z",
      "metadata": {},
      "output": "<string>",
      "browserUseVersion": "<string>",
      "isSuccess": true,
      "judgement": "<string>",
      "judgeVerdict": true,
      "cost": "<string>",
      "suggestions": [
        {}
      ]
    }
  ],
  "totalItems": 123,
  "pageNumber": 123,
  "pageSize": 123
}

Authorizations

​
X-Browser-Use-API-Key
string
header
required

Query Parameters

​
pageSize
integer
default:10
Required range: 1 <= x <= 100
​
pageNumber
integer
default:1
Required range: x >= 1
​
sessionId
string<uuid> | null
​
filterBy
enum<string> | null

Enumeration of possible task execution states

Attributes: CREATED: Task has been created but not yet started. STARTED: Task has been started and is currently running. FINISHED: Task has finished and the agent has completed the task. STOPPED: Task execution has been manually stopped (cannot be resumed).

Available options:
created,
started,
finished,
stopped
​
after
string<date-time> | null
​
before
string<date-time> | null

Response

Successful Response

Response model for paginated task list requests.

​
items
TaskItemView · object[]
required

List of task views for the current page

​
totalItems
integer
required

Total number of items in the list

​
pageNumber
integer
required

Page number

​
pageSize
integer
required

Number of items per page