Skip to main content
GET
/
groups
curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/groups?offset=0' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'

{
    "groups": [
{
    "id": 1,
    "parentId": null,
    "name": "Sales Team",
    "usersCount": 10,
    "coursesCount": 5,
    "image": {
    "id": 1234,
    "original": "http://example.com/images/original/1234.jpg",
    "mini": "http://example.com/images/mini/1234.jpg",
    "small": "http://example.com/images/small/1234.jpg"
}
}
    ],
    "totalCount": 1
}
Retrieve a paginated list of all groups on your platform.

​
Request Headers

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

​
Query Parameters

​
offset
integer
Entry number to start listing from. Use this for pagination.Example: 20 to get the second page of results

​
Response

​
groups
array
required
Array of group objects
​
totalCount
integer
required
The total number of groups
curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/groups?offset=0' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'

{
    "groups": [
{
    "id": 1,
    "parentId": null,
    "name": "Sales Team",
    "usersCount": 10,
    "coursesCount": 5,
    "image": {
    "id": 1234,
    "original": "http://example.com/images/original/1234.jpg",
    "mini": "http://example.com/images/mini/1234.jpg",
    "small": "http://example.com/images/small/1234.jpg"
}
}
    ],
    "totalCount": 1
}