Get Users

Users in EdApp are anyone who has access to the EdApp system. Based on the role users have access to the “Learners app” (web.edapp.com or mobile application), the “admin portal” (admin.edapp.com) or both. 

Get Users

The get endpoint can be used to retrieve a list of all user information within an application. It returns a full list of all users and all of their details saved within the EdApp system.

GET

https://rest.edapp.com/v2/users

Parameters

Parameter Description Data Type
Page (Optional)  Page number  Integer 
PageSize (Optional) Page size Integer
UserName User name can be an email address String
ExternalId External Id String

 

Response

Field  Description  Data Type

totalCount

The total number of records the query returns

integer

items

An array of the records for the requested page

array
id

Ed UserId

string

externalId

External Id’s are an optional addition to a user’s profile that allow for easier referencing of users through the API.

string
name

Username

string
email

User’s email

string

userGroups

User Groups are used in EdApp to sort and deliver content appropriately. For example, you could have a sales user group to which all sales learning content is delivered.

array

userGroupsManaged

Users with the manager- analytics role can perform basic analytics on user groups without access to other admin permissions. In this space a user can be assigned as a manager of certain user groups.

array

firstName

User’s first name

string

lastName

User’s last name

string

customFields

Custom fields are used in EdApp to assign variable values to users. These can be declared in the EdApp LMS and then assigned to any user as a key-value pair. For example, the field jobTitle could be used to declare a user’s job title. This field can then be used by our EdApp dynamic user groups to sort and deliver content automatically.

array of key / value pairs

roles The EdApp system has users with various types and roles. The default roles for users created by this endpoint are app-user and prizing-user. These 2 roles create a fully functional leaner who can consume content within EdApp. Other roles include account-admin, content-author, manager-analytics, exclude-from-analytics, and reviewer. 
 
 
 array

 

Example

{
"totalCount": 0,
"items": [
{
"id": "string",
"externalId": "string",
"name": "string",
"email": "string",
"userGroups": [
"string"
],
"userGroupsManaged": [
"string"
],
"firstName": "string",
"lastName": "string",
"customFields": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"roles": [
"string"
]
}
]
}