---
title: User Groups API
description: This page outlines the key concepts regarding user groups in EdApp, and the various endpoints available in the User Groups API.
---
[Skip to content](https://support.edapp.com/api/user-groups#main-content)
English
Show submenu for translations
![EdApp - logo dark mode-1.png\]](https://support.edapp.com/hs-fs/hubfs/EdApp%20-%20logo%20dark%20mode-1.png?height=40&name=EdApp%20-%20logo%20dark%20mode-1.png)
- [Default HubSpot Blog](https://edapp-5741180.hs-sites.com/blog)
Open main navigation
Close main navigation
- [Default HubSpot Blog](https://edapp-5741180.hs-sites.com/blog)
- English
Show submenu for translations
- [edapp.com](https://www.edapp.com/)
[edapp.com](https://www.edapp.com/)
Hello. How can we help you?
- There are no suggestions because the search field is empty.
1. [Help Center](https://support.edapp.com/?hsLang=en)
2. [Technical / API documentation](https://support.edapp.com/technical-api-documentation?hsLang=en)
3. [API](https://support.edapp.com/technical-api-documentation?hsLang=en#api)
# User Groups API
## This page outlines the key concepts regarding user groups in EdApp, and the various endpoints available in the User Groups API.
### User Groups API Overview
The [EdApp Users Groups API](https://rest.edapp.com/docs/index.html#/User%20Groups) contains the following endpoints (click the links to see detailed documentation):
- [**POST /v2/usergroups**](https://rest.edapp.com/docs/index.html#/User%20Groups/UserGroup_CreateUserGroup): Create a new user group in your account
- **[GET /v2/usersgroups](https://rest.edapp.com/docs/index.html#/User%20Groups/UserGroup_GetAllUserGroups)**: Get all user groups in your account
- **[GET /v2/usergroups/{groupId}/children](https://rest.edapp.com/docs/index.html#/User%20Groups/UserGroup_GetChildrenUserGroups)**: Get child user groups of a user group
- **[POST /v2/usergroups/{groupId}/users](https://rest.edapp.com/docs/index.html#/User%20Groups/UserGroup_AddUserToGroup)**: Add a user to a user group
- **[DELETE /v2/usergroups/{groupId}/users](https://rest.edapp.com/docs/index.html#/User%20Groups/UserGroup_RemoveUserFromUserGroup)**: Remove a user from a user group
- **[GET /v2/usersgroups/{groupId}/users](https://rest.edapp.com/docs/index.html#/User%20Groups/UserGroup_GetUsers)**: Get all users in a user group
Read on below for more details about user groups in EdApp.
### User Groups in EdApp
User groups in EdApp are used to sort and deliver content.
A course can be assigned to a user group, which grants the users *within* the group (and any child groups) access to the course.
Groups can be hierarchical, for example, you might have a tiered structure based on location:
- Australia ← **Course A** is assigned here
- New South Wales ← **Course B** is assigned here
- Sydney
- Newcastle ← **Course C** is assigned here
Users in both the **Sydney** and **Newcastle** groups will have access to both **Course A** and **Course B**, but only the **Newcastle** group will have access to **Course C**.
### Invite Codes
**Invite codes** are used in EdApp as a means for learner registration.
A user group can have an attached invite code. When a user registers themselves on the learners app with an invite code for a specific user group, they are automatically assigned to that user group.
An invite code can be supplied when [creating a user group via the User Groups API](https://rest.edapp.com/docs/index.html#/User%20Groups/UserGroup_CreateUserGroup).
- [Getting started](https://support.edapp.com/getting-started?hsLang=en#main-content)
- [Get Started in 5 Minutes](https://support.edapp.com/getting-started?hsLang=en#get-started-in-5-minutes)
- [Lessons & Courses](https://support.edapp.com/getting-started?hsLang=en#lessons-courses)
- [Basic User Management](https://support.edapp.com/getting-started?hsLang=en#basic-user-management)
- [Course Library](https://support.edapp.com/getting-started?hsLang=en#course-library)
- [Definitions](https://support.edapp.com/getting-started?hsLang=en#definitions)
- [Admin portal](https://support.edapp.com/admin-portal?hsLang=en#main-content)
- [Advanced User Management](https://support.edapp.com/admin-portal?hsLang=en#advanced-user-management)
- [Lesson Management](https://support.edapp.com/admin-portal?hsLang=en#lesson-management)
- [Course Management](https://support.edapp.com/admin-portal?hsLang=en#course-management)
- [App Customisation](https://support.edapp.com/admin-portal?hsLang=en#app-customisation)
- [Peer Learning](https://support.edapp.com/admin-portal?hsLang=en#peer-learning)
- [Engagement](https://support.edapp.com/admin-portal?hsLang=en#engagement)
- [Analytics](https://support.edapp.com/admin-portal?hsLang=en#analytics)
- [Features](https://support.edapp.com/admin-portal?hsLang=en#features)
- [EducateAll](https://support.edapp.com/admin-portal?hsLang=en#educateall)
- [Sharing Content](https://support.edapp.com/admin-portal?hsLang=en#sharing-content)
- [Integrations](https://support.edapp.com/admin-portal?hsLang=en#integrations)
- [Learner's app](https://support.edapp.com/learners-app?hsLang=en#main-content)
- [Logging In](https://support.edapp.com/learners-app?hsLang=en#logging-in)
- [Taking Courses](https://support.edapp.com/learners-app?hsLang=en#taking-courses)
- [Features For Learners](https://support.edapp.com/learners-app?hsLang=en#features-for-learners)
- [Extras](https://support.edapp.com/learners-app?hsLang=en#extras)
- [Star Bar](https://support.edapp.com/learners-app?hsLang=en#star-bar)
- [Creator Tool](https://support.edapp.com/creator-tool?hsLang=en#main-content)
- [Branding](https://support.edapp.com/creator-tool?hsLang=en#branding)
- [Templates](https://support.edapp.com/creator-tool?hsLang=en#templates)
- [Course & Lesson Configurations](https://support.edapp.com/creator-tool?hsLang=en#course-lesson-configurations)
- [Copying Slides/Lessons/Courses](https://support.edapp.com/creator-tool?hsLang=en#copying-slides-lessons-courses)
- [Translations](https://support.edapp.com/creator-tool?hsLang=en#translations)
- [Content](https://support.edapp.com/creator-tool?hsLang=en#content)
- [Tips and tricks](https://support.edapp.com/tips-and-tricks?hsLang=en#main-content)
- [Learning Programme Management](https://support.edapp.com/tips-and-tricks?hsLang=en#learning-programme-management)
- [Authoring](https://support.edapp.com/tips-and-tricks?hsLang=en#authoring)
- [Best Practices](https://support.edapp.com/tips-and-tricks?hsLang=en#best-practices)
- [Programme Success](https://support.edapp.com/tips-and-tricks?hsLang=en#programme-success)
- [Engagement](https://support.edapp.com/tips-and-tricks?hsLang=en#engagement)
- [Launch Kit](https://support.edapp.com/tips-and-tricks?hsLang=en#launch-kit)
- [FAQ](https://support.edapp.com/faq?hsLang=en#main-content)
- [Lessons & Courseware](https://support.edapp.com/faq?hsLang=en#lessons-courseware)
- [Authoring](https://support.edapp.com/faq?hsLang=en#authoring)
- [User Registration & Management](https://support.edapp.com/faq?hsLang=en#user-registration-management)
- [Display](https://support.edapp.com/faq?hsLang=en#display)
- [Engagement](https://support.edapp.com/faq?hsLang=en#engagement)
- [Peer Learning](https://support.edapp.com/faq?hsLang=en#peer-learning)
- [Knowledge Performance](https://support.edapp.com/faq?hsLang=en#knowledge-performance)
- [Analytics](https://support.edapp.com/faq?hsLang=en#analytics)
- [System & Technical Support](https://support.edapp.com/faq?hsLang=en#system-technical-support)
- [Subscriptions & Pricing](https://support.edapp.com/faq?hsLang=en#subscriptions-pricing)
- [Educate All](https://support.edapp.com/faq?hsLang=en#educate-all)
- [Contact & Support](https://support.edapp.com/faq?hsLang=en#contact-support)
- [Webinars](https://support.edapp.com/webinars?hsLang=en)
- [Technical / API documentation](https://support.edapp.com/technical-api-documentation?hsLang=en#main-content)
- [Single Sign On for the Learner's Portal](https://support.edapp.com/technical-api-documentation?hsLang=en#single-sign-on-for-the-learners-portal)
- [Single Sign-on for Admin Portal](https://support.edapp.com/technical-api-documentation?hsLang=en#single-sign-on-for-admin-portal)
- [Integrations](https://support.edapp.com/technical-api-documentation?hsLang=en#integrations)
- [API](https://support.edapp.com/technical-api-documentation?hsLang=en#api)
- [Legal documentation](https://support.edapp.com/legal-documentation?hsLang=en#main-content)
- [Third Party Gateway](https://support.edapp.com/legal-documentation?hsLang=en#third-party-gateway)
- [Privacy & Terms](https://support.edapp.com/legal-documentation?hsLang=en#privacy-terms)
- [Troubleshooting](https://support.edapp.com/troubleshooting?hsLang=en)
- [EdApp to SC Migration](https://support.edapp.com/edapp-to-sc-migration?hsLang=en)
- [Default HubSpot Blog](https://edapp-5741180.hs-sites.com/blog)
[](http://edapp.com)
EdApp Help Center
Copyright © 2026, EdApp Pty Ltd