get_user_group
Fetch a user group's details by its unique ID from LearnWorlds. Read-only lookup returns the group data, ideal for reporting and verification without modifying the school.
Instructions
๐ข READ-ONLY ยท GET /v2/user_groups/{id}
Get a user group. Returns the user group specified by the provided user group id.
Behavior: read-only lookup against the live school; creates, changes and deletes nothing. Auth (admin API token + Lw-Client id) is injected server-side, never by the model; calls are throttled to stay under LearnWorlds' 30-per-10s cap and retried on 429/5xx.
Returns: HTTP <status> followed by the LearnWorlds JSON response body. A non-2xx reply surfaces as a tool error with that status and the API error payload โ 401 bad/expired token, 403 not permitted, 404 no such record, 422 rejected input.
Use when: safe to call speculatively for lookups and reporting. Not for changing anything โ use the matching ๐ก write tool. Related User groups tools: add_user_user_group, deletes_user_group, get_users_user_group, remove_user_user_group, update_user_group.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The unique identifier of the user group |