list_groups
Read-onlyIdempotent
List student groups to identify which learners can access published courses. Filter by group name or category, and page through results when more than one page exists.
Instructions
List student groups, one page at a time.
Group membership drives which published courses a learner can see, so this is
the starting point for any "who can access what" question. Results are one page:
when has_more is true, call again with next_cursor.
`filter_name` is a case-INSENSITIVE substring match. Note that group names
themselves are case-SENSITIVE and unique, so "Staff" and "staff" can both exist
and this filter will return both.
`filter_category_id` takes an obfuscated StudentGroupCategory id. An unknown or
cross-organization id returns zero results rather than an error, so an empty
list here does not prove the category does not exist.
Each group carries `updated_at` - most other Skilljar objects call this field
`modified_at`.
Requires the `student-groups:read` OAuth scope.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page_size | No | ||
| filter_name | No | ||
| page_cursor | No | ||
| filter_category_id | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | Yes | ||
| groups | Yes | ||
| has_more | Yes | ||
| next_cursor | No |