2.1.1 Group object

Represents a group. A group ties together a set of drills, a set of members (participants) and a set of test definitions.

Example

{
  "id": "nYrK9udUc-UGvRS2kxaPtaB-0wzeHAJzM6vlL1te6wI",
  "name": "European geography",
  "description": "Learn the countries and capitals of Europe",
  "counts": {
    "members": 10,
    "drillables": 20,
    "tests": 5
  }
}

Fields

Field	Type	Description
`id` required	String	The unique ID of this group. Example value: `nYrK9udUc-UGvRS2kxaPtaB-0wzeHAJzM6vlL1te6wI`
`name` optional	String	The name of this group. Example value: `European geography`
`description` optional	String	A description for this group. Example value: `Learn the countries and capitals of Europe`
`counts` optional	2.1.1 GroupCounts object	Aggregate details including counts of members, drills and tests.
`icon` optional	2.1.1 Media object	An icon to represent the group.
`created` optional	Date	The creation date and time of the group.
`lastEdited` optional	Date	The date and time the group was last changed.
`affordances` optional	List of strings	A list of affordances that the calling user may apply to this group.
`forcedMembershipNotification` optional	Boolean	Indicates whether new group members that were forced into the group will be sent a confirmation email.
`catalogRestriction` optional	2.1.1 CatalogRestriction object	The catalog that is used to restrict this group's content and members to.
`sensitiveContent` optional	Boolean	Indicates whether this group contains sensitive content.
`communicationConfig` optional	2.1.1 CommunicationConfig object	Defines how group members are notified.
`subscriptionTermination` optional	2.1.1 SubscriptionTermination object	Defines when group memberships automatically end.

Last updated on 2025-04-18