List Profiles

Get paginated list of profiles.

Use the query parameter to search profiles by name or user_id. This is useful when you have many profiles and need to find a specific user.

Example: If you set user_id to your internal user identifier when creating profiles, you can later search for that user by passing their identifier as the query parameter.

GET /profiles

List Profiles

JavaScript

const options = {method: 'GET', headers: {'X-Browser-Use-API-Key': '<api-key>'}};

fetch('https://api.browser-use.com/api/v2/profiles', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "userId": "<string>",
      "name": "<string>",
      "lastUsedAt": "2023-11-07T05:31:56Z",
      "cookieDomains": [
        "<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

query · string | null

Maximum string length: 200

Response

200

application/json

Successful Response

Response model for paginated profile list requests.

items · ProfileView · object[] · required

List of profile views for the current page

Show child attributes

totalItems · integer · required

Total number of items in the list

pageNumber · integer · required

Page number

pageSize · integer · required

Number of items per page