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

fetch('https://api.browser-use.com/api/v3/workspaces', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "name": "<string>"
    }
  ],
  "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

Response

Successful Response

Response model for paginated workspace list requests.

​
items
WorkspaceView · object[]
required

List of workspace 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