List Browser Sessions

Get paginated list of browser sessions with optional status filtering.

Headers

X-Browser-Use-API-KeystringRequired

Query parameters

pageSizeintegerOptional>=1<=100Defaults to 10
pageNumberintegerOptional>=1Defaults to 1
filterByenum or nullOptional

Enumeration of possible browser session states

Attributes: ACTIVE: Session is currently active and running (browser is running) STOPPED: Session has been stopped and is no longer active (browser is stopped)

Allowed values:

Response

Successful Response
itemslist of objects
List of browser session views for the current page
totalItemsinteger
Total number of items in the list
pageNumberinteger
Page number
pageSizeinteger
Number of items per page

Errors