Skip to main content
GET
/
users
/
{userId}
/
groups
curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/users/1234567890/groups' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'

{
    "groups": [
        {
            "id": 1,
            "parentId": null,
            "name": "Sales Team",
            "usersCount": 15,
            "coursesCount": 5,
            "image": null,
            "attributes": {}
        },
        {
            "id": 2,
            "parentId": 1,
            "name": "Regional Sales - London",
            "usersCount": 8,
            "coursesCount": 3,
            "image": null,
            "attributes": {}
        }
    ]
}
Retrieve a list of all groups that a specific user is a member of.

​
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

​
groups
array
required
Array of groups the user belongs to

​
Error Responses

​
404
object
Returned when user is not found
curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/users/1234567890/groups' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'

{
    "groups": [
        {
            "id": 1,
            "parentId": null,
            "name": "Sales Team",
            "usersCount": 15,
            "coursesCount": 5,
            "image": null,
            "attributes": {}
        },
        {
            "id": 2,
            "parentId": 1,
            "name": "Regional Sales - London",
            "usersCount": 8,
            "coursesCount": 3,
            "image": null,
            "attributes": {}
        }
    ]
}