Skip to main content
GET
List sessions

Authorizations

Authorization
string
header
required

A workspace API key from Settings → API keys in the dashboard (https://app.driver.dev), sent as a bearer token.

Query Parameters

page
integer
default:1

The page number for pagination.

Required range: x >= 1
Example:

1

pageSize
integer
default:20

The number of sessions per page, 1 to 100. Larger values are clamped to 100. The number of sessions per page.

Required range: 1 <= x <= 100
Example:

20

status
enum<string>

Only sessions in exactly this status. Filter sessions by status.

Available options:
starting,
active,
completed,
error
Example:

"active"

Response

Successfully retrieved list of browser sessions.

page
integer
required

The current page number.

pageSize
integer
required

The number of sessions per page.

total
integer
required

The total number of sessions.

totalPages
integer
required

The total number of pages.

sessions
object[]
required

Array of browser sessions.