Skip to main content
GET
/
courses
/
{courseId}
/
assignments
/
groups
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
}

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 groups that 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 group assignment objects
​
totalCount
integer
required
Total number of group 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/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
}