DashboardChangelogCareersSign up
GuidesAPI ReferenceCLIMCP
GET/browsers

List all browser sessions with pagination support. Use status parameter to filter by session state.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

status?string

Filter sessions by status. "active" returns only active sessions (default), "deleted" returns only soft-deleted sessions, "all" returns both.

Default"active"

Value in

  • "active"
  • "deleted"
  • "all"
include_deleted?boolean
Deprecated

Deprecated: Use status=all instead. When true, includes soft-deleted browser sessions in the results alongside active sessions.

Defaultfalse
limit?integer

Maximum number of results to return. Defaults to 20, maximum 100.

Range1 <= value <= 100
Default20
offset?integer

Number of results to skip. Defaults to 0.

Range0 <= value
Default0
query?string

Search browsers by name, session ID, profile ID, proxy ID, or pool name.

tags?

Filter sessions by tag key-value pairs using deepObject style, e.g. ?tags[team]=backend&tags[env]=staging. Multiple pairs are ANDed: a session must match every supplied pair exactly.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/browsers"
[  {    "created_at": "2019-08-24T14:15:22Z",    "cdp_ws_url": "string",    "webdriver_ws_url": "string",    "browser_live_view_url": "string",    "base_url": "string",    "headless": true,    "stealth": true,    "gpu": true,    "session_id": "string",    "name": "string",    "timeout_seconds": 0,    "profile": {      "id": "string",      "name": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "last_used_at": "2019-08-24T14:15:22Z"    },    "proxy_id": "string",    "pool": {      "id": "string",      "name": "string"    },    "viewport": {      "width": 1,      "height": 1,      "refresh_rate": 1    },    "kiosk_mode": true,    "start_url": "string",    "chrome_policy": {},    "tags": {      "property1": "string",      "property2": "string"    },    "deleted_at": "2019-08-24T14:15:22Z",    "usage": {      "uptime_ms": 0    },    "telemetry": {      "browser": {        "console": {          "enabled": true        },        "page": {          "enabled": true        },        "interaction": {          "enabled": true        },        "network": {          "enabled": true        },        "control": {          "enabled": true        },        "connection": {          "enabled": true        },        "system": {          "enabled": true        },        "screenshot": {          "enabled": true        },        "captcha": {          "enabled": true        }      }    }  }]

Create a browser session POST

Create a new browser session from within an action.