Skip to main content
GET
List roleplay sessions

Authorizations

Authorization
string
header
required

API key created in Settings > API.

Format: exec_live_ followed by 40 alphanumeric characters.

Query Parameters

user_ids
string

Comma-separated user IDs to filter by. When combined with user_emails, results are unioned (all matching users from either list are included).

Example:

"u1a2b3c4d5e6,u7v8w9x0y1z2"

user_emails
string

Comma-separated user email addresses to filter by. When combined with user_ids, results are unioned (all matching users from either list are included).

scenario_ids
string

Comma-separated scenario IDs to filter by

collection_ids
string

Comma-separated collection IDs to filter by

skill_ids
string

Comma-separated skill IDs to filter by

program_ids
string

Comma-separated program IDs to filter by

group_ids
string

Comma-separated workspace group IDs to filter by

rank
enum<string>[]

Filter by one or more performance ranks

Available options:
gold,
silver,
bronze,
unranked
Example:
start_date
string<date-time>

ISO 8601 datetime — only include sessions created on or after this date

end_date
string<date-time>

ISO 8601 datetime — only include sessions created on or before this date

exclude_system_users
boolean
default:false

Exclude sessions from system users (emails ending in @exec.com). Default false.

sorting
enum<string>
default:-created_at

Sort field. Prefix with - for descending order.

Available options:
created_at,
-created_at,
score,
-score,
duration,
-duration
page
integer
default:1

Page number (1-indexed)

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

Number of results per page (max 100)

Required range: 1 <= x <= 100

Response

Paginated list of roleplay sessions

data
object[]
pagination
object