Skip to main content
POST
List Sessions

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer | null
Required range: 1 <= x <= 1000
page_size
integer | null
Required range: 1 <= x <= 1000
offset
integer | null
Required range: 0 <= x <= 10000
page
integer | null
Required range: x >= 1
cursor
string | null
include_total
boolean
default:false

Body

application/json

Request payload for listing sessions.

Attributes: status: Optional status filter filters: Optional additional filters sort: Optional sort configuration

Example: python request = ListSessionsRequest( status="active", filters={"user_id": "user_123"} )

status
enum<string> | null

Filter by session status

Available options:
active,
idle,
archived,
terminated
filters
Filters · object | null

Additional filters

sort
Sort · object | null

Sort configuration

Response

Successful Response

Response for listing sessions.

Attributes: results: List of session summaries total: Total number of sessions matching query pagination: Pagination information

Example: python response = ListSessionsResponse( results=[...], total=50, pagination={...} )

results
GetSessionResponse · object[]
required

Session list

total
integer
required

Total matching sessions

pagination
Pagination · object
required

Pagination information