Skip to main content
GET
/
sessions
List Sessions
curl --request GET \
  --url https://api.example.com/sessions \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "session_id": "<string>",
      "timeout_minutes": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "last_accessed_at": "2023-11-07T05:31:56Z",
      "status": "active",
      "closed_at": "2023-11-07T05:31:56Z",
      "duration": "<string>",
      "steps": [
        {}
      ],
      "error": "<string>",
      "credit_usage": 123,
      "proxies": false,
      "browser_type": "chromium",
      "use_file_storage": false,
      "network_request_bytes": 0,
      "network_response_bytes": 0
    }
  ],
  "page": 123,
  "page_size": 123,
  "has_next": true,
  "has_previous": true
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-notte-request-origin
string | null
x-notte-sdk-version
string | null

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
page_size
integer
default:10

Number of items per page

Required range: 1 <= x <= 100
only_active
boolean
default:true

Whether to only return active sessions

only_current_token
boolean
default:false

Whether to only return sessions for the current token (apikey)

Response

Successful Response

items
SessionResponse · object[]
required
page
integer
required
page_size
integer
required
has_next
boolean
required
has_previous
boolean
required