A user is member of zero or more groups. Content is unlocked for users based on the groups they are member of.
Reporting rights and sub-admin permissions are also assigned on a group. See Permissions via the API.
Part of Web API v3 for user management. You need a token with the v3:groupmemberships:read or v3:groupmemberships:write scope, see Authenticating with the Web API v3.
Direct and indirect group memberships
The API only shows direct group membership.
In the TinQwise learning platform, users are considered to be indirect members of the parent groups of the groups they are in.
Taking the example structure in Groups and group types via the API, a user will be considered to be an indirect member of the "Netherlands" group when they are in the "Amsterdam" group.
Retrieving group memberships
Use the GET /api/v3/public/group_memberships/ endpoint to retrieve a list of all group memberships.
Field | Description |
| The uuid of the group. |
| The uuid of the user. |
Creating group memberships
POST a user UUID and group UUID to /api/v3/public/group_memberships/ to add a user to a group.
Deleting group memberships
Send a DELETE to /api/v3/public/group_memberships/{group_uuid}/{user_uuid}/ to remove a user from a group.
đ§ Be careful
Be careful when deleting group memberships. Some group memberships are used for internal purposes, such as programme access (Programme group group type) or to keep track of which voucher was used to create the user (voucher group type).
âď¸ Tip
In general, it is a good rule of thumb to only delete memberships of groups that are also created through the API.
Modifying group memberships
Memberships can not be modified. They can only be listed, created or deleted.