List groups
Groups of the portal with name, description and number of users.
GET https://cotlet.dev/api/v1/learnupon/groups
read
Returns the groups you can see: admins see all of them, a manager sees only the groups assigned to them. Use group_id as the group parameter of the other tools. users is the count LearnUpon shows on the group page.
Parameters
| Name | Type | Description |
|---|---|---|
| query string | string | Part of the group name. |
Request
curl https://cotlet.dev/api/v1/learnupon/groups \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("learnupon", "list_groups")const result = await cotlet.call('learnupon', 'list_groups');cotlet call learnupon list_groupsExample response
{
"groups": [
{
"group_id": "4821",
"name": "Onboarding",
"description": "New hires, first 90 days",
"users": 10
},
{
"group_id": "4830",
"name": "Warehouse",
"description": "Warehouse team",
"users": 48
}
]
}