Skip to main content
GET
List scenario assignments

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).

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

program_ids
string

Comma-separated program IDs to filter by

status
enum<string>[]

Filter by one or more assignment statuses

Available options:
not_started,
in_progress,
completed,
past_due,
did_not_pass
Example:
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 assignments

data
object[]
pagination
object