GET
/
groups
/
{groupId}
curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/groups/123' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'

{
    "id": 123,
    "parentId": 1,
    "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"
}
}

Retrieve detailed information about a specific group by its ID.

​
Path Parameters

​
groupId
integer
required

The unique identifier of the group to retrieve

​
Request Headers

​
X-API-KEY
string
required

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

​
Response

​
id
integer
required
Group ID
​
parentId
integer
Parent group ID
​
name
string
required
Name of the group
​
usersCount
integer
required
Number of users in the group
​
coursesCount
integer
required
Number of courses assigned to the group
​
image
object

Group cover image details

​
Error Responses

​
404
object

Returned when the group is not found

curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/groups/123' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'

{
    "id": 123,
    "parentId": 1,
    "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"
}
}