SMsmarterproctoring
Course

Search for users enrolled in a course by name

Changed on
get/v1/installs/{installSid}/courses/{courseSid}/users

Request

  • Base URL
    https://api.smarterproctoring.com
  • URL
    https://api.smarterproctoring.com/v1/installs/{installSid}/courses/{courseSid}/users
  • Auth
    API key in header token

Path parameters

installSidstring required

Unique SID of the application install. Pattern: AI + 32 hex chars.

Example:AI1234567890abcdef1234567890abcdef
courseSidstring required

Unique SID of the course. Pattern: CU + 32 hex chars.

Example:CU1234567890abcdef1234567890abcdef

Query parameters

searchstring required

Search term to match against first name or last name (case-insensitive, partial match). Use empty string to return all users.

offsetinteger

Zero-based offset for pagination.

role'learner' | 'instructor'

Filter results to a specific enrollment role. If omitted, all roles are returned.

limitinteger

Maximum number of results to return. Default 25, max 100.

Response

Successful

string required

Changes