Sign in
latestOpenAPI 3.0.02026-08-19219210532.7 KB

bd5a5f406bca

role-play-session

List role-play sessions with pagination

get/api/v1/role-play-sessions

Query parameters

idsstring[] nullable

Array of IDs to filter results. To skip this filter, omit the key entirely from your JSON. Never write the bare word undefined (that is invalid JSON). Empty arrays and null are also treated as omission.

pagenumber

Page number starting from 1.

limitnumber

Limit for the number of results per page.

orgIdstring

Optional. Restrict sessions to a specific organization. Omit to use the current user organization.

userIdsstring[]

Optional. Restrict sessions to specific learner IDs. Omit to include sessions from all learners.

missionReferenceIdsstring[]

Optional. Restrict sessions to specific mission reference IDs. Omit to include all missions.

trackIdsstring[]

Optional. Restrict sessions to specific parent track IDs. Omit to include all tracks.

state'PENDING' | 'PROCESSING' | 'DONE'

Optional. Filter sessions by state. Omit to include sessions in any state.

createdAfterstring date-time

Optional. Lower bound (inclusive) of session creation date, ISO 8601. Omit for no lower bound.

createdBeforestring date-time

Optional. Upper bound (exclusive) of session creation date, ISO 8601 — sessions strictly before this instant are returned. Omit for no upper bound.

completedAfterstring date-time

Optional. Lower bound (inclusive) of session completion time (completedAt, falling back to createdAt) for completed sessions, ISO 8601. Omit for no lower bound.

missionTitlestring

Optional. Filter sessions by mission title (substring match). Omit to include sessions regardless of mission title.

scorecardReferenceIdsstring[]

Optional. Restrict sessions to specific scorecard reference IDs. Omit to include all scorecards.

createdAt'ASC' | 'DESC'
missionTitle'ASC' | 'DESC'
score'ASC' | 'DESC'

Response