GET /api/v1/users/{user_email}
Retrieve basic information about a given user.
Returns:
_id
: user’s idmail
: user’s mailfirstName
: user’s first namelastName
: user’s first nameassignedPrograms
: programs assigned to the user.primaryGroupId
: primary group of the user, if any.averageScore
: average score in the programs followed by the usercertifications
: array of certifications obtained by the usercustomFields
: array of custom fields assigned to the userchampionAchievements
: achievements obtained by the user in the Champions category. Categories are:coursesCreated
(possible values:Champion
,Guide
,Role Model
andGuru
),repliesOnOwnActivitiesGiven
(possible values:Educator
,Teacher
,Professor
,Expert
) andpositiveReactionsOnOwnContent
(possible values:Recognized
,Renowned
,Acclaimed
andGlorious
).comments
: number of comments posted by the usercompletedPrograms
: number of completed programscustom
: user’s additional informationmanagers
: array of managers for the usersubordinates
: array of managees for the usergroups
: array of groups to which the user belongsimageUrl
: url of the profile picture of the userlastLoginAt
: last date when the user logged in (GMT)championStatus
: status of the user in the Champions categorylearnerAchievements
: achievements obtained as a Learnermessages
: number of messages postedpublications
: number of courses or programs publishedreactions
: number of reactions in the activities forumsskills
: array of skills obtained by the usertoDeactivateAt
: default empty. Deactivation date if an automatic deletion date is set to the userpaths
: array of Paths obtained by the usertotalTimeSpentInMinutes
: total time spent by the user playing learning itemsexternalIds
: list of third-party integration ID(s) for the user
Changelog:
- Milestone R (Aug 21): added customFields
- Milestone T (March 20): Added the totalTimeSpendInMinutes response field
- Milestone S (February 20): Added the paths field in the response
- Milestone P (October 19): Added several fields
- May 25th, 2022: Removed fields
coursesPublished
andauthoringToolExplored
withinchampionAchievements
.
Servers
- https://app.360learning.com
Path parameters
Name | Type | Required | Description |
---|---|---|---|
user_email |
String | Yes |
user’s mail |
Query parameters
Name | Type | Required | Description |
---|---|---|---|
company |
String | No |
(Optional) Include the company ID to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods. |
apiKey |
String | No |
(Optional) Include the API key to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.