Learnifier
  1. User Groups
Learnifier
  • Course Designs
    • Lists all global course design templates
      GET
  • Organization Units
    • Get Organization Unit with External Id
      GET
    • Organization Units
      GET
    • Adds an Organization Unit
      POST
    • Get Organization Unit
      GET
    • Updates an Organization Unit
      PATCH
  • Users
    • Gets a participation by external id
      GET
    • Gets a user by external id
      GET
    • Lists all users
      GET
    • Adds a user
      POST
    • User information
      GET
    • Updates user information
      PATCH
    • User profile picture
      GET
    • Returns information about the projects the user is a participant in.
      GET
  • Projects
    • Gets Organization Unit by external id
      GET
    • Organization Unit Projects
      GET
    • Create project
      POST
    • Deletes the project
      DELETE
    • Project information
      GET
    • Update project information
      PATCH
    • Project participants
      GET
    • Add participant
      POST
    • Deletes a participant
      DELETE
    • Activate participant
      POST
    • Participant login link
      POST
    • Project team members
      GET
  • Global User Groups
    • List Global User Groups.
    • List of all users in group.
  • User Groups
    • List User Groups.
      GET
    • Create a User Group.
      POST
    • Get user group
      GET
    • List of all users in group.
      GET
    • Add user group member.
      POST
    • Remove user group member.
      DELETE
  1. User Groups

List User Groups.

GET
/orgunits/{orgid}/usergroups
User Groups
Returns a list of User Groups for the org unit.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://learnifier.com/orgunits//usergroups'
Response Response Example
200 - Example 1
[
    {
        "children": [
            {}
        ],
        "globalId": 0,
        "groupId": 0,
        "name": "string",
        "parent": 0,
        "userGroup": 0
    }
]

Request

Path Params
orgid
integer 
required
ID of organization

Responses

🟢200List of User Groups.
application/json
Body
array of:
children
array[object (UserGroup) {6}] 
optional
Children User Groups.
children
array[object (UserGroup) {6}] 
optional
Children User Groups.
globalId
integer <int64>
optional
Global group ID if this group is based on a global group, otherwise null.
groupId
integer <int64>
optional
Unique identifier representing a User Group. Id numbers are never reused.
name
string 
required
The name of the User Group.
parent
integer <int64>
optional
Unique identifier of the parent or null if there is no parent.
userGroup
integer <int64>
optional
If of internal user group object that holds the members of this group.
globalId
integer <int64>
optional
Global group ID if this group is based on a global group, otherwise null.
groupId
integer <int64>
optional
Unique identifier representing a User Group. Id numbers are never reused.
name
string 
required
The name of the User Group.
parent
integer <int64>
optional
Unique identifier of the parent or null if there is no parent.
userGroup
integer <int64>
optional
If of internal user group object that holds the members of this group.
🔴500Unexpected error
Previous
List of all users in group.
Next
Create a User Group.
Built with