# Absorb LMS

> Manage learners, enrollments and groups in Absorb LMS, and read courses, departments and certificates.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/absorb-lms

## Actions

### Add users to group

Add users to a group you manage yourself.

**Inputs**

- Group (`group_id`, text, required): The group.
- Users (`user_ids`, list, required): The users.

**Outputs**

- `data` (object): The response from Absorb LMS.

**Example output**

```json
{
  "data": {}
}
```

### Create group

Create a group you add users to yourself.

**Inputs**

- Name (`name`, text, required): The group's name.
- External ID (`external_id`, text): The group's ID in another system.
- Department (`department_id`, text): Limit the group to this department.

**Outputs**

- `data` (object): The response from Absorb LMS.

**Example output**

```json
{
  "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 (`username`, text, required): The name the user signs in with. It must be unique in the portal.
- First name (`first_name`, text, required): The user's first name.
- Last name (`last_name`, text, required): The user's last name.
- Department (`department_id`, text, required): The department the user belongs to.
- Email address (`email_address`, text): The user's email address.
- Password (`password`, text): 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_id`, text): The user's ID in another system, such as your HR system.
- Job title (`job_title`, text): The user's job title.
- Employee number (`employee_number`, text): The user's employee number.
- Phone (`phone`, text): The user's phone number.
- Location (`location`, text): Where the user works.
- Date hired (`date_hired`, date): The day the user was hired.
- Supervisor (`supervisor_id`, text): The user's supervisor.
- Status (`active_status`, text): Whether the user can sign in and take courses. One of: `Active`, `Inactive`.

**Outputs**

- `data` (object): The response from Absorb LMS.

**Example output**

```json
{
  "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_id`, text, required): The user.
- Course (`course_id`, text, required): The course.
- Re-enroll (`re_enroll`, true/false): Enroll the user again even if they already have an enrollment, starting the course over.

**Outputs**

- `data` (object): The response from Absorb LMS.

**Example output**

```json
{
  "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_id`, text, required): The user.
- Course (`course_id`, text, required): The instructor-led course.
- Session (`session_id`, text, required): The session to enroll the user in.
- Re-enroll (`re_enroll`, true/false): Enroll the user again even if they already have an enrollment, starting the course over.

**Outputs**

- `data` (object): The response from Absorb LMS.

**Example output**

```json
{
  "data": {
    "courseId": "example",
    "enrollmentId": "example",
    "sessionEnrollmentId": "example",
    "sessionId": "example",
    "userId": "example"
  }
}
```

### Get course

Read a course's details.

**Inputs**

- Course (`course_id`, text, required): The course.

**Outputs**

- `data` (object): The response from Absorb LMS.

**Example output**

```json
{
  "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_id`, text, required): The group.

**Outputs**

- `data` (object): The response from Absorb LMS.

**Example output**

```json
{
  "data": {
    "dateAdded": "example",
    "dateEdited": "example",
    "id": "example",
    "isAutomatic": true,
    "name": "example",
    "userIds": [
      "example"
    ]
  }
}
```

### Get user

Read a user's details.

**Inputs**

- User (`absorb_user_id`, text, required): The user.

**Outputs**

- `data` (object): The response from Absorb LMS.

**Example output**

```json
{
  "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_id`, text, required): The user.
- Course (`course_id`, text, required): The course.

**Outputs**

- `data` (object): The response from Absorb LMS.

**Example output**

```json
{
  "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_id`, text, required): The course.
- Status (`status`, text): 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_since`, date and time): Only include records changed on or after this date and time.
- Page (`page`, number): 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_size`, number): How many results to read per page, up to 1000. Leave empty for 100. From 1 to 1000.

**Outputs**

- `data` (object): The response from Absorb LMS.

**Example output**

```json
{
  "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_id`, text, required): The instructor-led course.

**Outputs**

- `data` (list): The response from Absorb LMS.

**Example output**

```json
{
  "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_contains`, text): Only include courses whose name contains this.
- Course type (`course_type`, text): Only include courses of this type. One of: `Online course`, `Instructor-led course`, `Course bundle`, `Curriculum`.
- Status (`active_status`, text): Only include active or only inactive courses. One of: `Active`, `Inactive`.
- Changed since (`edited_since`, date and time): Only include records changed on or after this date and time.
- Page (`page`, number): 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_size`, number): How many results to read per page, up to 1000. Leave empty for 100. From 1 to 1000.

**Outputs**

- `data` (object): The response from Absorb LMS.

**Example output**

```json
{
  "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_name`, text): Only include departments with this name.
- External ID (`external_id`, text): Only include the department with this ID from another system.
- Page (`page`, number): 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_size`, number): How many results to read per page, up to 1000. Leave empty for 100. From 1 to 1000.

**Outputs**

- `data` (object): The response from Absorb LMS.

**Example output**

```json
{
  "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_contains`, text): Only include groups whose name contains this.
- Page (`page`, number): 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_size`, number): How many results to read per page, up to 1000. Leave empty for 100. From 1 to 1000.

**Outputs**

- `data` (object): The response from Absorb LMS.

**Example output**

```json
{
  "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_id`, text, required): The user.
- Page (`page`, number): 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_size`, number): How many results to read per page, up to 1000. Leave empty for 100. From 1 to 1000.

**Outputs**

- `data` (object): The response from Absorb LMS.

**Example output**

```json
{
  "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_id`, text, required): The user.
- Status (`status`, text): 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_since`, date and time): Only include records changed on or after this date and time.
- Page (`page`, number): 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_size`, number): How many results to read per page, up to 1000. Leave empty for 100. From 1 to 1000.

**Outputs**

- `data` (object): The response from Absorb LMS.

**Example output**

```json
{
  "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_address`, text): Only include the user with this email address.
- Username (`username`, text): Only include the user with this username.
- Department (`department_id`, text): Only include users in this department.
- Status (`active_status`, text): Only include active or only inactive users. One of: `Active`, `Inactive`.
- Added since (`added_since`, date and time): Only include records added on or after this date and time.
- Changed since (`edited_since`, date and time): Only include records changed on or after this date and time.
- Page (`page`, number): 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_size`, number): How many results to read per page, up to 1000. Leave empty for 100. From 1 to 1000.

**Outputs**

- `data` (object): The response from Absorb LMS.

**Example output**

```json
{
  "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_id`, text, required): The group.
- Users (`user_ids`, list, required): The users.

**Outputs**

- `data` (object): The response from Absorb LMS.

**Example output**

```json
{
  "data": {}
}
```

### Unenroll user from course

Remove a user's enrollment in a course.

**Inputs**

- User (`absorb_user_id`, text, required): The user.
- Course (`course_id`, text, required): The course.

**Outputs**

- `data` (object): The response from Absorb LMS.

**Example output**

```json
{
  "data": {
    "enrollmentId": "example",
    "unenrolled": true
  }
}
```

### Update user

Change a user's details. Details you leave empty keep their current values.

**Inputs**

- User (`absorb_user_id`, text, required): The user.
- Username (`username`, text): The name the user signs in with. It must be unique in the portal.
- First name (`first_name`, text): The user's first name.
- Last name (`last_name`, text): The user's last name.
- Department (`department_id`, text): The department the user belongs to.
- Email address (`email_address`, text): The user's email address.
- Password (`password`, text): 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_id`, text): The user's ID in another system, such as your HR system.
- Job title (`job_title`, text): The user's job title.
- Employee number (`employee_number`, text): The user's employee number.
- Phone (`phone`, text): The user's phone number.
- Location (`location`, text): Where the user works.
- Date hired (`date_hired`, date): The day the user was hired.
- Supervisor (`supervisor_id`, text): The user's supervisor.
- Status (`active_status`, text): Whether the user can sign in and take courses. One of: `Active`, `Inactive`.

**Outputs**

- `data` (object): The response from Absorb LMS.

**Example output**

```json
{
  "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"
  }
}
```
