Retrieves all group sets associated with a specific course in the Blackboard learning management system. Group sets are collections of groups within a course that can be used for various collaborative activities, such as group projects, discussions, or assignments. This endpoint…
namestringThe group "name" value to use as search criteria. See also: nameCompare. **Since**: 3900.10.0
sortstringProperties to sort by. This is a comma-delimited list of JSON properties, with an optional "(desc)" suffix to request a descending sort for that property. e.g. "name(desc)" Supported fields are: - name - externalId **Since**: 3100.4.0
limitintegerThe maximum number of results to be returned. There may be less if the query returned less than the maximum.
fieldsstringA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.
offsetintegerThe number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter.
createdstringSearch for groups with created date relative to this value. "createdCompare" may also be sent to control search behavior. **Since**: 3800.8.0
courseIdRequiredstringThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 |…
modifiedstringSearch for groups with modified date relative to this value. "modifiedCompare" may also be sent to control search behavior. **Since**: 3800.8.0
nameComparestringUsed alongside the "name" search parameter. Defaults to StartsWith if not specified. **Since**: 3900.10.0 | Type | Description | --------- | --------- | | equals | | | notEquals | | | contains | | | notContains | | | startsWith | |
createdComparestringUsed alongside the "created" search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.8.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |
modifiedComparestringUsed alongside the "modified" search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.8.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |
nonEmptyGroupSetsbooleanSearch group sets whose student count is greater than 0. **Since**: 3900.71.0
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
OAuth connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.