Retrieve a list of all groups that 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 group assignment objectsShow Assignment object properties
Timestamp when the course was assigned
Exact timestamp when the assignment expires
Period within which group members must complete the courseShow Deadline period properties
Time unit (hours, days, weeks, months)
Group detailsShow Group object properties
Number of users in the group
Number of courses assigned to the group
Total number of group 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/groups \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'
{
"assignments": [
{
"assignedAt": 1443183322,
"deadlineAt": 0,
"deadlinePeriod": {
"measure": "months",
"value": 3
},
"group": {
"id": 1,
"parentId": null,
"name": "Sales Team",
"usersCount": 10,
"coursesCount": 5
}
}
],
"totalCount": 1
}