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
}
Courses
List Course Users
Get the list of users assigned to the course
GET
/
courses
/
{courseId}
/
assignments
/
users
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
}
Retrieve a list of all users who have been assigned to a specific course.
Path Parameters
integer
required
The unique identifier of the course
Request Headers
string
required
API Key. Go to your Konstantly site > Settings > API and copy the value from there.
Response
array
required
Array of user assignment objects
Show Assignment object properties
Show Assignment object properties
integer
required
Timestamp when the course was assigned
integer
required
Timestamp when user started the course
integer
required
Assignment deadline timestamp
integer
required
Timestamp when user finished the course
integer
required
Current progress (0-100)
integer
required
Result value (0-100)
boolean
required
Whether user has started the course
boolean
required
Whether user has finished the course
boolean
required
Whether the assignment has expired
integer
required
Total number of assignments
Error Responses
object
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
}
Was this page helpful?