SMsmarterproctoring
Exam

List Exams

Changed on

Returns a paginated list of exams belonging to the specified course.<br/><br/>Supports filtering with includeStatusSummary to include enrollment status counts per exam.<br/><br/>Supports sorting by title, examOpenDate, or scheduleOpenDate.

get/v1/installs/{installSid}/courses/{courseSid}/exams

Request

  • Base URL
    https://api.smarterproctoring.com
  • URL
    https://api.smarterproctoring.com/v1/installs/{installSid}/courses/{courseSid}/exams
  • 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

offsetinteger

Zero-based offset for pagination.

limitinteger

Maximum number of exam records to return.

Example:50
includeStatusSummaryboolean

When true, includes a summary of enrollment statuses (e.g., scheduled, completed, not started) for each exam.

Example:true
excludeReadinessExamsboolean

When true, excludes readiness exams from the results. Defaults to true.

Example:true
sortKeysstring[]

Array of field names to sort by. Valid values: title, examOpenDate, scheduleOpenDate.

sortOrder'ASC' | 'DESC'

Sort direction. ASC for ascending or DESC for descending.

dobstring date

Date of birth filter (internal use).

Response

Successful

string required

Changes