GET
/
users
/
{userId}
/
assignments
curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/users/1234567890/assignments' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'
{
    "assignments": [
{
    "assignedAt": 1443183322,
    "startedAt": 1443188932,
    "deadlineAt": 1444188932,
    "finishedAt": 1443188946,
    "progressValue": 100,
    "resultValue": 50,
    "isCourseStarted": true,
    "isCourseFinished": true,
    "isExpired": false,
    "course": {
    "id": 123,
    "name": "Introduction to Sales",
    "annotation": "Learn the basics of sales",
    "isDraft": false,
    "createdAt": 1507807711,
    "updatedAt": 1507808372,
    "publishedAt": 1508225229,
    "image": null
}
}
    ]
}

Retrieve a list of all courses assigned to a specific user.

Request Headers

X-API-KEY
string
required

API Key. Go to your Konstantly site > Settings > API and copy the value from there.

URL Parameters

userId
string
required

User API ID

Response

assignments
array
required

Array of course assignments

Error Responses

404
object

Not Found error response

curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/users/1234567890/assignments' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'
{
    "assignments": [
{
    "assignedAt": 1443183322,
    "startedAt": 1443188932,
    "deadlineAt": 1444188932,
    "finishedAt": 1443188946,
    "progressValue": 100,
    "resultValue": 50,
    "isCourseStarted": true,
    "isCourseFinished": true,
    "isExpired": false,
    "course": {
    "id": 123,
    "name": "Introduction to Sales",
    "annotation": "Learn the basics of sales",
    "isDraft": false,
    "createdAt": 1507807711,
    "updatedAt": 1507808372,
    "publishedAt": 1508225229,
    "image": null
}
}
    ]
}