OpenAPI 3.1.02026-08-183894205.8 MB
f67a043e3190
Course students
List course students
Returns a paginated list of students enrolled in a course, with optional name filtering.
Required permissions:
- courses:read
- course_analytics:read
get/course_students
Query parameters
afterstring
Returns the elements in the list that come after the specified cursor.
beforestring
Returns the elements in the list that come before the specified cursor.
firstinteger
Returns the first n elements from the list.
Example:42
lastinteger
Returns the last n elements from the list.
Example:42
course_idstring required
The unique identifier of the course to list enrolled students for.
Example:cors_xxxxxxxxxxxxx
keywordstring
A search term to filter students by name or username.
Response
A successful response
Example response
{
"data": [
{
"completed_lessons_count": 42,
"completion_rate": 6.9,
"first_interaction_at": "2023-12-01T05:00:00.401Z",
"last_interaction_at": "2023-12-01T05:00:00.401Z",
"total_lessons_count": 42,
"user": {
"id": "user_xxxxxxxxxxxxx",
"name": "John Doe",
"username": "johndoe42"
}
}
]
}