Sign in
course-students

GET `/api/v0/main-frontend/courses/{course_id}/students/users`

Changed on
get/api/v0/main-frontend/courses/{course_id}/students/users

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

course_idstring uuid required

Course id

Query parameters

pageinteger

Page number (1-based)

limitinteger

Page size (1-10000)

searchstring

Filter by name/email substring or exact user id

sort_columnstring

last_name | first_name | email | total_points

sort_directionstring

asc | desc

course_instance_idstring uuid

Filter to a single course instance

module_idstring uuid

Scopes grade to this module's completions

gradestring

A sis-0-5 grade ("0".."5"), "passed"/"failed", or "not_completed"; requires module_id

registration_statusStudentFacingCreditRegistrationStatus[]

Only students holding a live credit registration at one of these stages; repeat the parameter for several

Response

A page of enrolled students

total_pagesinteger required

Changes