Skip to main content
GET
List Sessions
Retrieve a paginated list of sessions. All filter parameters are optional — if none are provided, all sessions are returned with pagination.

Request

Date range example

Single date example

Parameters

integer
Page number (default: 1)
string
Filter by session status. One of: upcoming, ongoing, completed, cancelled
string
Filter by a single date (YYYY-MM-DD). Cannot be combined with start/end.
string
Start of date range (YYYY-MM-DD). Use with end.
string
End of date range (YYYY-MM-DD). Use with start.
string
Filter by host user ID

Response

The CustomRoles field is only included for Premium/Enterprise workspaces that have custom roles configured on their sessions.

Authorizations

apikey
string
header
required

Pass your API key in the apikey header. Alternatively, the x-api-key header is also accepted.

Query Parameters

page
integer
default:1

Page number (default: 1)

Required range: x >= 1
status
enum<string>

Filter by session status

Available options:
upcoming,
ongoing,
completed,
cancelled
date
string<date>

Filter by a single date (YYYY-MM-DD). Cannot be combined with start/end.

start
string<date>

Filter by date range start (YYYY-MM-DD). Use with end.

end
string<date>

Filter by date range end (YYYY-MM-DD). Use with start.

host
string

Filter by host user ID

Response

200

Sessions list