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

# Search for users enrolled in a course by name



## OpenAPI

````yaml https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/courses/{courseSid}/users
openapi: 3.0.0
info:
  title: SmarterProctoring API
  version: 3.0.3
  description: API documentation for SmarterProctoring
servers:
  - url: https://api.smarterproctoring.com
security:
  - client: []
tags:
  - name: App Install
    description: App Install operations
    x-group: App Install
  - name: Course
    description: Course operations
    x-group: Course
  - name: Course Offering
    description: Course Offering operations
    x-group: Course Offering
  - name: Exam
    description: Exam operations
    x-group: Exam
  - name: Exam Configuration
    description: Exam Configuration operations
    x-group: Exam Configuration
  - name: Exam Events
    description: Exam Events operations
    x-group: Exam Events
  - name: Exam Session
    description: Exam Session operations
    x-group: Exam Session
  - name: Exam Session Annotation
    description: Exam Session Annotation operations
    x-group: Exam Session Annotation
  - name: Exam Session Event
    description: Exam Session Event operations
    x-group: Exam Session Event
  - name: Onboarding
    description: Onboarding operations
    x-group: Onboarding
  - name: Provision
    description: Provision operations
    x-group: Provision
  - name: Reports
    description: Reports operations
    x-group: Reports
  - name: Time Zones
    description: Time Zones operations
    x-group: Time Zones
  - name: User
    description: User operations
    x-group: User
paths:
  /v1/installs/{installSid}/courses/{courseSid}/users:
    get:
      tags:
        - Course
      summary: Search for users enrolled in a course by name
      operationId: getV1InstallsInstallsidCoursesCoursesidUsers
      parameters:
        - name: installSid
          in: path
          schema:
            type: string
            description: >-
              Unique SID of the application install. Pattern: `AI` + 32 hex
              chars.
            example: AI1234567890abcdef1234567890abcdef
            pattern: ^AI[a-f0-9]{32}$
          description: 'Unique SID of the application install. Pattern: `AI` + 32 hex chars.'
          required: true
        - name: courseSid
          in: path
          schema:
            type: string
            description: 'Unique SID of the course. Pattern: `CU` + 32 hex chars.'
            example: CU1234567890abcdef1234567890abcdef
            pattern: ^CU[a-f0-9]{32}$
          description: 'Unique SID of the course. Pattern: `CU` + 32 hex chars.'
          required: true
        - name: search
          in: query
          schema:
            type: string
            description: >-
              Search term to match against first name or last name
              (case-insensitive, partial match). Use empty string to return all
              users.
            maxLength: 255
          description: >-
            Search term to match against first name or last name
            (case-insensitive, partial match). Use empty string to return all
            users.
          required: true
        - name: offset
          in: query
          schema:
            type: integer
            description: Zero-based offset for pagination.
            default: 0
            minimum: 0
          description: Zero-based offset for pagination.
        - name: role
          in: query
          schema:
            type: string
            description: >-
              Filter results to a specific enrollment role. If omitted, all
              roles are returned.
            enum:
              - learner
              - instructor
          description: >-
            Filter results to a specific enrollment role. If omitted, all roles
            are returned.
        - name: limit
          in: query
          schema:
            type: integer
            description: Maximum number of results to return. Default 25, max 100.
            default: 25
            minimum: 1
            maximum: 100
          description: Maximum number of results to return. Default 25, max 100.
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
components:
  securitySchemes:
    client:
      type: apiKey
      name: token
      in: header

````