v2

OpenAPI 3.0.02026-07-2163203194.5 KB
Course

Search for users enrolled in a course by name

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

Path parameters

installSidstring required

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

Example:AI1234567890abcdef1234567890abcdef

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

courseSidstring required

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

Example:CU1234567890abcdef1234567890abcdef

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

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.

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.

Zero-based offset for pagination.

role'learner' | 'instructor'

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

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

limitinteger

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

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

Response

Successful

string required