Retrieve a list of all users who have been assigned to a specific course.
Path Parameters
The unique identifier of the course
API Key. Go to your Konstantly site > Settings > API and copy the value from there.
Response
Array of user assignment objectsShow Assignment object properties
Timestamp when the course was assigned
Timestamp when user started the course
Assignment deadline timestamp
Timestamp when user finished the course
Whether user has started the course
Whether user has finished the course
Whether the assignment has expired
User detailsShow User object properties
Total number of assignments
Error Responses
Returned when the course is not foundShow Error object properties
curl --request GET \
--url https://YOURSITE.konstant.ly/openapi/v1/courses/123/assignments/users \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'
{
"assignments": [
{
"assignedAt": 1443183322,
"startedAt": 1443188932,
"deadlineAt": 1444188932,
"finishedAt": 1443188946,
"progressValue": 100,
"resultValue": 50,
"isCourseStarted": true,
"isCourseFinished": true,
"isExpired": false,
"user": {
"id": "1234567890",
"name": "John Doe",
"email": "john@example.com",
"role": {
"alias": "learner"
}
}
}
],
"totalCount": 1
}