Search for users enrolled in a course by name
Course
Search for users enrolled in a course by name
GET
Search for users enrolled in a course by name
Authorizations
Path Parameters
Unique SID of the application install. Pattern: AI + 32 hex chars.
Pattern:
^AI[a-f0-9]{32}$Example:
"AI1234567890abcdef1234567890abcdef"
Unique SID of the course. Pattern: CU + 32 hex chars.
Pattern:
^CU[a-f0-9]{32}$Example:
"CU1234567890abcdef1234567890abcdef"
Query Parameters
Search term to match against first name or last name (case-insensitive, partial match). Use empty string to return all users.
Maximum string length:
255Zero-based offset for pagination.
Required range:
x >= 0Filter results to a specific enrollment role. If omitted, all roles are returned.
Available options:
learner, instructor Maximum number of results to return. Default 25, max 100.
Required range:
1 <= x <= 100Response
default - application/json
Successful
The response is of type string.
