Skip to content

User Group Enrollment Details

Endpoint used to retrieve a paginated report of the courses in which a student is enrolled within a specific group in Toolzz LMS.

Warning: This endpoint will only work correctly if the domain of your institution is manually provided in the URL. Otherwise, the endpoint may fail or return a validation error.

Terminal window
curl --request GET \
--url 'https://{your-institution-domain}/api/v1/reports/groups/{groupId}/students/{userId}/courses?page=1&perPage=20' \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": 1,
"title": "<string>",
"progress": "<string>"
}
]
}

ParameterTypeDescriptionRequired
AuthorizationStringAccess token (“Bearer” must be before the token)Yes
ParameterTypeDescriptionRequired
groupIdintCourse group ID.Yes
userIdstringUser ID.Yes
ParameterTypeDescriptionRequired
pagenumberSpecifies the page number of results to be returned.No
perPagenumberDefines the number of courses to display per page. Maximum value: 1000.No

To access this endpoint, it is necessary to send a valid access token through the authorization header (Authorization) of the request. Additionally, the API is protected by other security measures to safeguard user data.