Skip to main content
GET
Search for users enrolled in a course by name

Authorizations

token
string
header
required

Path Parameters

installSid
string
required

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

Pattern: ^AI[a-f0-9]{32}$
Example:

"AI1234567890abcdef1234567890abcdef"

courseSid
string
required

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: 255
offset
integer
default:0

Zero-based offset for pagination.

Required range: x >= 0
role
enum<string>

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

Available options:
learner,
instructor
limit
integer
default:25

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

Required range: 1 <= x <= 100

Response

default - application/json

Successful

The response is of type string.