Skip to main content
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
}

Documentation Index

Fetch the complete documentation index at: https://docs.konstantly.com/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve a list of all users who have been assigned to a specific course.

​
Path Parameters

​
courseId
integer
required
The unique identifier of the course

​
Request Headers

​
X-API-KEY
string
required
API Key. Go to your Konstantly site > Settings > API and copy the value from there.

​
Response

​
assignments
array
required
Array of user assignment objects
​
totalCount
integer
required
Total number of assignments

​
Error Responses

​
404
object
Returned when the course is not found
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
}