List groups

List the learner groups of your WorkRamp.

GET https://cotlet.dev/api/v1/workramp/groups

read

Returns each group name with its member count. Group names are what the group filter of list_learners and list_assignments takes.

Parameters

Parameters: list_groups
NameTypeDescription
cursor string string Next page cursor from the previous call.

Request

cURL
curl https://cotlet.dev/api/v1/workramp/groups \
  -H "Authorization: Bearer $COTLET_API_KEY"
Python
result = client.call("workramp", "list_groups")
Node.js
const result = await cotlet.call('workramp', 'list_groups');
CLI
cotlet call workramp list_groups

Example response

JSON

{
  "groups": [
    {
      "name": "Sales",
      "members": 12
    },
    {
      "name": "Support",
      "members": 20
    }
  ],
  "next_cursor": null
}

Sign in once. Your agent does the rest.

Sign up and add the apps you need. Free 7-day trial with 2,000 credits, no card needed.