Absorb LMS
App · 20 actions
Manage learners, enrollments and groups in Absorb LMS, and read courses, departments and certificates.
Actions
| Action | What it does |
|---|---|
| Add users to group | Add users to a group you manage yourself. |
| Create group | Create a group you add users to yourself. |
| Create user | Add a new user to Absorb LMS. |
| Enroll user in course | Enroll a user in an online course, curriculum, course bundle or single-session instructor-led course. |
| Enroll user in session | Enroll a user in a session of an instructor-led course. |
| Get course | Read a course's details. |
| Get group | Read a group and its members. |
| Get user | Read a user's details. |
| Get user's enrollment | Read a user's enrollment in a course, with their progress and status. |
| List course enrollments | List the users enrolled in a course, with their progress and status. |
| List course sessions | List the sessions of an instructor-led course. |
| List courses | Find courses, filtered by name, type, status or when they were changed. |
| List departments | List the departments you can see, optionally by name or external ID. |
| List groups | List the groups of users, with their members. |
| List user's certificates | List the certificates a user has earned. |
| List user's enrollments | List the courses a user is enrolled in, with their progress and status. |
| List users | Find users, filtered by email address, department, status or when they were added or changed. |
| Remove users from group | Take users out of a group you manage yourself. |
| Unenroll user from course | Remove a user's enrollment in a course. |
| Update user | Change a user's details. |
Add users to group
Add users to a group you manage yourself.
Inputs
- Group
group_idtextRequired - The group.
- Users
user_idslistRequired - The users.
Outputs
dataobject- The response from Absorb LMS.
Example output
{
"data": {}
}Create group
Create a group you add users to yourself.
Inputs
- Name
nametextRequired - The group's name.
- External ID
external_idtext - The group's ID in another system.
- Department
department_idtext - Limit the group to this department.
Outputs
dataobject- The response from Absorb LMS.
Example output
{
"data": {
"dateAdded": "example",
"externalId": "example",
"id": "example",
"isAutomatic": true,
"name": "example",
"scopedDepartmentId": "example"
}
}Create user
Add a new user to Absorb LMS. A username that's already taken is refused.
Inputs
- Username
usernametextRequired - The name the user signs in with. It must be unique in the portal.
- First name
first_nametextRequired - The user's first name.
- Last name
last_nametextRequired - The user's last name.
- Department
department_idtextRequired - The department the user belongs to.
- Email address
email_addresstext - The user's email address.
- Password
passwordtext - A password for the user to sign in with. Leave empty when they sign in another way, such as single sign-on.
- External ID
external_idtext - The user's ID in another system, such as your HR system.
- Job title
job_titletext - The user's job title.
- Employee number
employee_numbertext - The user's employee number.
- Phone
phonetext - The user's phone number.
- Location
locationtext - Where the user works.
- Date hired
date_hireddate - The day the user was hired.
- Supervisor
supervisor_idtext - The user's supervisor.
- Status
active_statustext - Whether the user can sign in and take courses.One of:
Active,Inactive.
Outputs
dataobject- The response from Absorb LMS.
Example output
{
"data": {
"id": "example",
"username": "example"
}
}Enroll user in course
Enroll a user in an online course, curriculum, course bundle or single-session instructor-led course.
Inputs
- User
absorb_user_idtextRequired - The user.
- Course
course_idtextRequired - The course.
- Re-enroll
re_enrolltrue/false - Enroll the user again even if they already have an enrollment, starting the course over.
Outputs
dataobject- The response from Absorb LMS.
Example output
{
"data": {
"courseId": "example",
"enrollmentId": "example",
"userId": "example"
}
}Enroll user in session
Enroll a user in a session of an instructor-led course.
Inputs
- User
absorb_user_idtextRequired - The user.
- Course
course_idtextRequired - The instructor-led course.
- Session
session_idtextRequired - The session to enroll the user in.
- Re-enroll
re_enrolltrue/false - Enroll the user again even if they already have an enrollment, starting the course over.
Outputs
dataobject- The response from Absorb LMS.
Example output
{
"data": {
"courseId": "example",
"enrollmentId": "example",
"sessionEnrollmentId": "example",
"sessionId": "example",
"userId": "example"
}
}Get course
Read a course's details.
Inputs
- Course
course_idtextRequired - The course.
Outputs
dataobject- The response from Absorb LMS.
Example output
{
"data": {
"activeStatus": 1,
"categoryId": "example",
"courseType": "example",
"dateAdded": "example",
"dateEdited": "example",
"description": "example",
"externalId": "example",
"id": "example",
"name": "example"
}
}Get group
Read a group and its members.
Inputs
- Group
group_idtextRequired - The group.
Outputs
dataobject- The response from Absorb LMS.
Example output
{
"data": {
"dateAdded": "example",
"dateEdited": "example",
"id": "example",
"isAutomatic": true,
"name": "example",
"userIds": [
"example"
]
}
}Get user
Read a user's details.
Inputs
- User
absorb_user_idtextRequired - The user.
Outputs
dataobject- The response from Absorb LMS.
Example output
{
"data": {
"activeStatus": 1,
"dateAdded": "example",
"dateEdited": "example",
"dateHired": "example",
"departmentId": "example",
"emailAddress": "example",
"employeeNumber": "example",
"externalId": "example",
"firstName": "example",
"id": "example",
"isAdmin": true,
"isInstructor": true,
"isLearner": true,
"jobTitle": "example",
"lastLoginDate": "example",
"lastName": "example",
"supervisorId": "example",
"username": "example"
}
}Get user's enrollment
Read a user's enrollment in a course, with their progress and status.
Inputs
- User
absorb_user_idtextRequired - The user.
- Course
course_idtextRequired - The course.
Outputs
dataobject- The response from Absorb LMS.
Example output
{
"data": {
"certificateId": "example",
"courseId": "example",
"courseName": "example",
"dateAdded": "example",
"dateCompleted": "example",
"dateDue": "example",
"dateEdited": "example",
"dateExpires": "example",
"dateStarted": "example",
"fullName": "example",
"id": "example",
"isActive": true,
"progress": 1,
"score": 1,
"status": 1,
"userId": "example"
}
}List course enrollments
List the users enrolled in a course, with their progress and status.
Inputs
- Course
course_idtextRequired - The course.
- Status
statustext - Only include enrollments with this status.One of:
Not started,In progress,Pending approval,Complete,Not complete,Failed,Declined,Pending evaluation,On waitlist,Absent, and 3 more. - Changed since
edited_sincedate and time - Only include records changed on or after this date and time.
- Page
pagenumber - Which page of results to read: 0 is the first page, 1 the second, and so on.From 0 to 65535.
- Results per page
page_sizenumber - How many results to read per page, up to 1000. Leave empty for 100.From 1 to 1000.
Outputs
dataobject- The response from Absorb LMS.
Example output
{
"data": {
"enrollments": [
{
"certificateId": "example",
"courseId": "example",
"courseName": "example",
"dateAdded": "example",
"dateCompleted": "example",
"dateDue": "example",
"dateEdited": "example",
"dateExpires": "example",
"dateStarted": "example",
"fullName": "example",
"id": "example",
"isActive": true,
"progress": 1,
"score": 1,
"status": 1,
"userId": "example"
}
],
"limit": 1,
"offset": 1,
"returnedItems": 1,
"totalItems": 1
}
}List course sessions
List the sessions of an instructor-led course.
Inputs
- Course
course_idtextRequired - The instructor-led course.
Outputs
datalist- The response from Absorb LMS.
Example output
{
"data": [
{
"description": "example",
"enrollmentEndDate": "example",
"enrollmentStartDate": "example",
"externalId": "example",
"id": "example",
"isWaitlistEnabled": true,
"maximumClassSize": 1,
"name": "example"
}
]
}List courses
Find courses, filtered by name, type, status or when they were changed.
Inputs
- Name contains
name_containstext - Only include courses whose name contains this.
- Course type
course_typetext - Only include courses of this type.One of:
Online course,Instructor-led course,Course bundle,Curriculum. - Status
active_statustext - Only include active or only inactive courses.One of:
Active,Inactive. - Changed since
edited_sincedate and time - Only include records changed on or after this date and time.
- Page
pagenumber - Which page of results to read: 0 is the first page, 1 the second, and so on.From 0 to 65535.
- Results per page
page_sizenumber - How many results to read per page, up to 1000. Leave empty for 100.From 1 to 1000.
Outputs
dataobject- The response from Absorb LMS.
Example output
{
"data": {
"courses": [
{
"activeStatus": 1,
"categoryId": "example",
"courseType": "example",
"dateAdded": "example",
"dateEdited": "example",
"description": "example",
"externalId": "example",
"id": "example",
"name": "example"
}
],
"limit": 1,
"offset": 1,
"returnedItems": 1,
"totalItems": 1
}
}List departments
List the departments you can see, optionally by name or external ID.
Inputs
- Department name
department_nametext - Only include departments with this name.
- External ID
external_idtext - Only include the department with this ID from another system.
- Page
pagenumber - Which page of results to read: 0 is the first page, 1 the second, and so on.From 0 to 65535.
- Results per page
page_sizenumber - How many results to read per page, up to 1000. Leave empty for 100.From 1 to 1000.
Outputs
dataobject- The response from Absorb LMS.
Example output
{
"data": {
"departments": [
{
"companyName": "example",
"dateAdded": "example",
"dateEdited": "example",
"emailAddress": "example",
"externalId": "example",
"id": "example",
"name": "example",
"parentId": "example"
}
],
"limit": 1,
"offset": 1,
"returnedItems": 1,
"totalItems": 1
}
}List groups
List the groups of users, with their members.
Inputs
- Name contains
name_containstext - Only include groups whose name contains this.
- Page
pagenumber - Which page of results to read: 0 is the first page, 1 the second, and so on.From 0 to 65535.
- Results per page
page_sizenumber - How many results to read per page, up to 1000. Leave empty for 100.From 1 to 1000.
Outputs
dataobject- The response from Absorb LMS.
Example output
{
"data": {
"groups": [
{
"dateAdded": "example",
"dateEdited": "example",
"id": "example",
"isAutomatic": true,
"name": "example",
"userIds": [
"example"
]
}
],
"limit": 1,
"offset": 1,
"returnedItems": 1,
"totalItems": 1
}
}List user's certificates
List the certificates a user has earned.
Inputs
- User
absorb_user_idtextRequired - The user.
- Page
pagenumber - Which page of results to read: 0 is the first page, 1 the second, and so on.From 0 to 65535.
- Results per page
page_sizenumber - How many results to read per page, up to 1000. Leave empty for 100.From 1 to 1000.
Outputs
dataobject- The response from Absorb LMS.
Example output
{
"data": {
"certificates": [
{
"acquiredDate": "example",
"courseName": "example",
"dateAdded": "example",
"enrollmentId": "example",
"expiryDate": "example",
"fullName": "example",
"id": "example"
}
],
"limit": 1,
"offset": 1,
"returnedItems": 1,
"totalItems": 1
}
}List user's enrollments
List the courses a user is enrolled in, with their progress and status.
Inputs
- User
absorb_user_idtextRequired - The user.
- Status
statustext - Only include enrollments with this status.One of:
Not started,In progress,Pending approval,Complete,Not complete,Failed,Declined,Pending evaluation,On waitlist,Absent, and 3 more. - Changed since
edited_sincedate and time - Only include records changed on or after this date and time.
- Page
pagenumber - Which page of results to read: 0 is the first page, 1 the second, and so on.From 0 to 65535.
- Results per page
page_sizenumber - How many results to read per page, up to 1000. Leave empty for 100.From 1 to 1000.
Outputs
dataobject- The response from Absorb LMS.
Example output
{
"data": {
"enrollments": [
{
"certificateId": "example",
"courseId": "example",
"courseName": "example",
"dateAdded": "example",
"dateCompleted": "example",
"dateDue": "example",
"dateEdited": "example",
"dateExpires": "example",
"dateStarted": "example",
"fullName": "example",
"id": "example",
"isActive": true,
"progress": 1,
"score": 1,
"status": 1,
"userId": "example"
}
],
"limit": 1,
"offset": 1,
"returnedItems": 1,
"totalItems": 1
}
}List users
Find users, filtered by email address, department, status or when they were added or changed.
Inputs
- Email address
email_addresstext - Only include the user with this email address.
- Username
usernametext - Only include the user with this username.
- Department
department_idtext - Only include users in this department.
- Status
active_statustext - Only include active or only inactive users.One of:
Active,Inactive. - Added since
added_sincedate and time - Only include records added on or after this date and time.
- Changed since
edited_sincedate and time - Only include records changed on or after this date and time.
- Page
pagenumber - Which page of results to read: 0 is the first page, 1 the second, and so on.From 0 to 65535.
- Results per page
page_sizenumber - How many results to read per page, up to 1000. Leave empty for 100.From 1 to 1000.
Outputs
dataobject- The response from Absorb LMS.
Example output
{
"data": {
"limit": 1,
"offset": 1,
"returnedItems": 1,
"totalItems": 1,
"users": [
{
"activeStatus": 1,
"dateAdded": "example",
"dateEdited": "example",
"dateHired": "example",
"departmentId": "example",
"emailAddress": "example",
"employeeNumber": "example",
"externalId": "example",
"firstName": "example",
"id": "example",
"isAdmin": true,
"isInstructor": true,
"isLearner": true,
"jobTitle": "example",
"lastLoginDate": "example",
"lastName": "example",
"supervisorId": "example",
"username": "example"
}
]
}
}Remove users from group
Take users out of a group you manage yourself.
Inputs
- Group
group_idtextRequired - The group.
- Users
user_idslistRequired - The users.
Outputs
dataobject- The response from Absorb LMS.
Example output
{
"data": {}
}Unenroll user from course
Remove a user's enrollment in a course.
Inputs
- User
absorb_user_idtextRequired - The user.
- Course
course_idtextRequired - The course.
Outputs
dataobject- The response from Absorb LMS.
Example output
{
"data": {
"enrollmentId": "example",
"unenrolled": true
}
}Update user
Change a user's details. Details you leave empty keep their current values.
Inputs
- User
absorb_user_idtextRequired - The user.
- Username
usernametext - The name the user signs in with. It must be unique in the portal.
- First name
first_nametext - The user's first name.
- Last name
last_nametext - The user's last name.
- Department
department_idtext - The department the user belongs to.
- Email address
email_addresstext - The user's email address.
- Password
passwordtext - A password for the user to sign in with. Leave empty when they sign in another way, such as single sign-on.
- External ID
external_idtext - The user's ID in another system, such as your HR system.
- Job title
job_titletext - The user's job title.
- Employee number
employee_numbertext - The user's employee number.
- Phone
phonetext - The user's phone number.
- Location
locationtext - Where the user works.
- Date hired
date_hireddate - The day the user was hired.
- Supervisor
supervisor_idtext - The user's supervisor.
- Status
active_statustext - Whether the user can sign in and take courses.One of:
Active,Inactive.
Outputs
dataobject- The response from Absorb LMS.
Example output
{
"data": {
"activeStatus": 1,
"dateAdded": "example",
"dateEdited": "example",
"dateHired": "example",
"departmentId": "example",
"emailAddress": "example",
"employeeNumber": "example",
"externalId": "example",
"firstName": "example",
"id": "example",
"isAdmin": true,
"isInstructor": true,
"isLearner": true,
"jobTitle": "example",
"lastLoginDate": "example",
"lastName": "example",
"supervisorId": "example",
"username": "example"
}
}