> ## Documentation Index
> Fetch the complete documentation index at: https://docs.exec.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List scenario assignments

> Returns a paginated list of scenario assignments in the workspace.

Assignments represent tasks given to users to practice specific scenarios. Each
assignment tracks status (not_started, in_progress, completed, past_due, did_not_pass),
best score, attempt count, and completion requirements.

Filter by user, scenario, program, or status to find specific assignments.




## OpenAPI

````yaml /api-reference/openapi.yaml get /scenarios/assignments
openapi: 3.0.3
info:
  title: Exec API
  version: '1.0'
  description: >
    REST API for programmatic access to your Exec workspace.


    Use the Exec API to read workspace data, list members, retrieve group
    information,

    and create interactive scenario creation sessions.


    ## Authentication

    All requests require a valid API key passed in the Authorization header:

    ```

    Authorization: Bearer exec_live_...

    ```


    Create API keys in your workspace settings under **Settings > API**.
servers:
  - url: https://api.exec.com/rest/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Knowledge Hub - Folders
    x-group: Knowledge Hub
  - name: Knowledge Hub - Pages
    x-group: Knowledge Hub
  - name: Knowledge Hub - Sources
    x-group: Knowledge Hub
paths:
  /scenarios/assignments:
    get:
      tags:
        - Scenarios
      summary: List scenario assignments
      description: >
        Returns a paginated list of scenario assignments in the workspace.


        Assignments represent tasks given to users to practice specific
        scenarios. Each

        assignment tracks status (not_started, in_progress, completed, past_due,
        did_not_pass),

        best score, attempt count, and completion requirements.


        Filter by user, scenario, program, or status to find specific
        assignments.
      operationId: listAssignments
      parameters:
        - name: user_ids
          in: query
          description: >-
            Comma-separated user IDs to filter by. When combined with
            user_emails, results are unioned (all matching users from either
            list are included).
          schema:
            type: string
        - name: user_emails
          in: query
          description: >-
            Comma-separated user email addresses to filter by. When combined
            with user_ids, results are unioned (all matching users from either
            list are included).
          schema:
            type: string
        - name: scenario_ids
          in: query
          description: Comma-separated scenario IDs to filter by
          schema:
            type: string
        - name: program_ids
          in: query
          description: Comma-separated program IDs to filter by
          schema:
            type: string
        - name: status
          in: query
          description: Filter by one or more assignment statuses
          style: form
          explode: false
          schema:
            type: array
            items:
              type: string
              enum:
                - not_started
                - in_progress
                - completed
                - past_due
                - did_not_pass
            example:
              - completed
              - past_due
        - name: page
          in: query
          description: Page number (1-indexed)
          schema:
            type: integer
            default: 1
            minimum: 1
        - name: page_size
          in: query
          description: Number of results per page (max 100)
          schema:
            type: integer
            default: 50
            minimum: 1
            maximum: 100
      responses:
        '200':
          description: Paginated list of assignments
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Assignment'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
              example:
                data:
                  - id: a1b2c3d4e5f6
                    user:
                      id: u1a2b3c4d5e6
                      email: jane@acme.com
                      first_name: Jane
                      last_name: Smith
                    scenario:
                      id: s1a2b3c4d5e6
                      name: Procurement Discovery
                      slug: procurement-discovery
                    status: completed
                    due_date: '2026-04-15T00:00:00Z'
                    best_score: 88
                    best_rank: gold
                    attempt_count: 3
                    attempt_min: 1
                    attempt_max: null
                    rank_min: silver
                    program: null
                    created_at: '2026-03-01T10:00:00Z'
                pagination:
                  page: 1
                  page_size: 50
                  total_count: 1
                  total_pages: 1
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Assignment:
      type: object
      description: A scenario assignment given to a user as a practice task.
      properties:
        id:
          type: string
          description: Unique assignment identifier
        user:
          $ref: '#/components/schemas/User'
        scenario:
          $ref: '#/components/schemas/ScenarioRef'
        status:
          type: string
          enum:
            - not_started
            - in_progress
            - completed
            - past_due
            - did_not_pass
          description: Current assignment status
        due_date:
          type: string
          format: date-time
          nullable: true
          description: When the assignment is due
        best_score:
          type: number
          nullable: true
          description: Highest score achieved on this assignment
        best_rank:
          type: string
          nullable: true
          enum:
            - gold
            - silver
            - bronze
            - unranked
          description: Rank from the best scoring attempt
        attempt_count:
          type: integer
          description: Number of completed attempts
        attempt_min:
          type: integer
          nullable: true
          description: Minimum attempts required
        attempt_max:
          type: integer
          nullable: true
          description: Maximum attempts allowed
        rank_min:
          type: string
          nullable: true
          enum:
            - gold
            - silver
            - bronze
            - unranked
          description: Minimum rank required to pass
        program:
          type: object
          nullable: true
          description: Program this assignment belongs to (null if standalone)
          properties:
            id:
              type: string
            name:
              type: string
        created_at:
          type: string
          format: date-time
    Pagination:
      type: object
      properties:
        page:
          type: integer
          description: Current page number
        page_size:
          type: integer
          description: Number of items per page
        total_count:
          type: integer
          description: Total number of items
        total_pages:
          type: integer
          description: Total number of pages
    User:
      type: object
      properties:
        id:
          type: string
          description: Unique user identifier
        email:
          type: string
          format: email
          description: User's email address
        first_name:
          type: string
          description: User's first name
        last_name:
          type: string
          description: User's last name
    ScenarioRef:
      type: object
      description: A compact scenario reference for embedding in other responses.
      properties:
        id:
          type: string
          description: Unique scenario identifier
        name:
          type: string
          description: Scenario name
        slug:
          type: string
          description: URL-friendly scenario identifier
    ValidationErrorDetail:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              description: Error category (e.g., "invalid_request")
            code:
              type: string
              description: Specific error code (e.g., "user_not_found")
            message:
              type: string
              description: Human-readable error message
  responses:
    BadRequest:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationErrorDetail'
          example:
            error:
              type: invalid_request
              code: invalid_pagination
              message: Invalid pagination parameters
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationErrorDetail'
          example:
            error:
              type: authentication_error
              code: invalid_api_key
              message: Invalid or inactive API key
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        API key created in Settings > API.

        Format: `exec_live_` followed by 40 alphanumeric characters.

````