Groups are the main method in the TinQwise learning platform to provide content differentiation and control permissions, see How to create and manage groups in Control.
The group structure is hierarchical. Most groups are subgroups of a parent group.
Part of Web API v3 for user management. You need a token with the v3:groups:read or v3:groups:write scope, see Authenticating with the Web API v3.
Group types
Group types are used to display group selectors in the frontend and have some configuration options.
Some group types are created by the system, such as vouchers, Remote Scorm, Admin groups and Programme group.
đ§ Be careful
Group types should be used sparingly. Even big platforms have maybe ten different group types, not hundreds.
đ Good to know
It is currently not possible to manage group type details through the API, such as whether a group type shows in profiles and can be selected in a report. For more on group types, see All about group types.
Structuring your groups
It is good practice to give most groups a parent group with type sorting, which acts as a top-level group. For example:
Countries (type: sorting, parent:
null)Netherlands (type: country, parent: Countries)
Hilversum (type: city, parent: Netherlands)
Amsterdam (type: city, parent: Netherlands)
Belgium (type: country, parent: Countries)
Antwerp (type: city, parent: Belgium)
Vouchers (type: sorting, parent:
null)abcdef (type: voucher, parent: Vouchers)
Retrieving groups
Use the GET /api/v3/public/groups/ endpoint to retrieve a list of groups. You can filter on parent_uuid and group_type.
Field | Description |
| The unique identifier for this group. |
| The group type of this group. |
| The internationalized (i18n) or translated name for this group. A JSON object with keys corresponding to language codes (ISO 639-1) and values corresponding to localized names of this group. A translation should be provided for all supported languages on the platform. Example: |
| The uuid of the parent of this group. |
| Can be used to store a customer-specific identifier for this group, such as a uuid from an HR system. |
Creating and modifying groups
POST to /api/v3/public/groups/ creates a new group.
PUT or PATCH to /api/v3/public/groups/{uuid}/ will modify an existing group. The PUT requires all writable fields to be included, while the PATCH only updates provided fields.
Deleting groups
It is not possible to delete a group which is still referenced in an automation, or which is used for internal purposes such as a Programme group.
Next: Group memberships via the API to add users to the groups you created.