# TalentLMS

> Manage learners, courses, groups, branches and enrollments with the current TalentLMS API.

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/talentlms

## Actions

### Add group member

Add a user to a group.

**Inputs**

- Group (`group_id`, text, required): Group id.
- Learner (`learner_id`, text, required): Learner id.
- Enroll to courses (`enroll_to_courses`, true/false): Whether to force synchronous enrollment in the group's active courses. Default: `false`.

**Outputs**

- `data` (object): Talent LMS response data.

**Example output**

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

### Create branch

Create a branch.

**Inputs**

- Name (`name`, text, required): Name.
- Description (`description`, text): Description.
- Default locale (`default_locale`, text): Default locale.

**Outputs**

- `data` (object): Talent LMS response data.

**Example output**

```json
{
  "data": {
    "_data": {
      "email": "example",
      "id": 1,
      "login": "example",
      "name": "example"
    }
  }
}
```

### Create course

Create course.

**Inputs**

- Name (`name`, text, required): Name.
- Code (`code`, text): Code.
- Description (`description`, text): Description.
- Category (`category_id`, text): Category id.
- Price (`price`, number): Price.
- Capacity (`capacity`, number): Capacity.
- Level (`level`, number): Level.
- Time limit (`time_limit`, number): Time limit.
- Is active (`is_active`, true/false): Is active.
- Custom fields (`custom_fields`, object): Custom fields.

**Outputs**

- `data` (object): Talent LMS response data.

**Example output**

```json
{
  "data": {
    "_data": {
      "email": "example",
      "id": 1,
      "login": "example",
      "name": "example"
    }
  }
}
```

### Create group

Create a group.

**Inputs**

- Name (`name`, text, required): Name.
- Description (`description`, text): Description.
- Key (`key`, text): Key.
- Max key redemptions (`max_key_redemptions`, number): Max key redemptions.
- Price (`price`, number): Price.

**Outputs**

- `data` (object): Talent LMS response data.

**Example output**

```json
{
  "data": {
    "_data": {
      "email": "example",
      "id": 1,
      "login": "example",
      "name": "example"
    }
  }
}
```

### Create user

Create a user.

**Inputs**

- Name (`name`, text, required): Name.
- Surname (`surname`, text, required): Surname.
- Login (`login`, text, required): Login.
- Email (`email`, text, required): Email.
- Timezone (`timezone`, text): Timezone.
- Locale (`locale`, text): Locale.
- Email notifications (`email_notifications`, true/false): Email notifications.
- User type id (`user_type_id`, text): User type id.
- Status (`status`, true/false): Status.
- Password (`password`, text, required): Password.
- Description (`description`, text): Description.
- Credits (`credits`, number): Credits.
- Deactivation date (`deactivation_date`, date): Deactivation date.

**Outputs**

- `data` (object): Talent LMS response data.

**Example output**

```json
{
  "data": {
    "_data": {
      "avatar": {
        "default": "example",
        "lg": "example",
        "md": "example",
        "sm": "example",
        "xl": "example"
      },
      "email": "example",
      "id": 1,
      "integration_user_id": "example",
      "language": "example",
      "last_login": "example",
      "last_updated": "example",
      "login": "example",
      "name": "example",
      "registration": "example",
      "status": "example",
      "surname": "example",
      "timezone": "example",
      "type": "example"
    }
  }
}
```

### Delete branch

Delete a branch.

**Inputs**

- Branch (`branch_id`, text, required): Branch id.

**Outputs**

- `data` (object): Talent LMS response data.

**Example output**

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

### Delete course

Delete a course.

**Inputs**

- Course (`course_id`, text, required): Course id.

**Outputs**

- `data` (object): Talent LMS response data.

**Example output**

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

### Delete group

Delete a group.

**Inputs**

- Group (`group_id`, text, required): Group id.

**Outputs**

- `data` (object): Talent LMS response data.

**Example output**

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

### Delete user

Delete a user.

**Inputs**

- Learner (`learner_id`, text, required): Learner id.
- Permanent (`permanent`, true/false): Permanent. Default: `false`.

**Outputs**

- `data` (object): Talent LMS response data.

**Example output**

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

### Enroll user

Enroll user to course.

**Inputs**

- Course (`course_id`, text, required): Course id.
- Learner (`learner_id`, text, required): Learner id.

**Outputs**

- `data` (object): Talent LMS response data.

**Example output**

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

### Get branch

Get a branch.

**Inputs**

- Branch (`branch_id`, text, required): Branch id.

**Outputs**

- `data` (object): Talent LMS response data.

**Example output**

```json
{
  "data": {
    "_data": {
      "email": "example",
      "id": 1,
      "login": "example",
      "name": "example"
    }
  }
}
```

### Get course

Get a course.

**Inputs**

- Course (`course_id`, text, required): Course id.

**Outputs**

- `data` (object): Talent LMS response data.

**Example output**

```json
{
  "data": {
    "_data": {
      "email": "example",
      "id": 1,
      "login": "example",
      "name": "example"
    }
  }
}
```

### Get course progress

Get user's course progress.

**Inputs**

- Learner (`learner_id`, text, required): Learner id.
- Course (`course_id`, text, required): Course id.

**Outputs**

- `data` (object): Talent LMS response data.

**Example output**

```json
{
  "data": {
    "_data": {
      "category": {
        "id": 1,
        "name": "example",
        "parent_id": 1,
        "price": {}
      },
      "creation_date": "example",
      "enrolled": false,
      "enrolled_on": "example",
      "expired_on": "example",
      "id": 1,
      "last_updated_on": "example",
      "name": "example",
      "progress": {
        "certificate": {
          "archived": false,
          "certificate_id": 1,
          "certificate_name": "example",
          "expires_at": "example",
          "issued_at": "example",
          "url": "example"
        },
        "completion_date": "example",
        "completion_percentage": 1.0,
        "completion_status": "example",
        "last_viewed_unit_id": 1,
        "next_course_id": 1,
        "score": 1.0,
        "total_time": 1
      },
      "role_in_course": "example",
      "status": "example"
    }
  }
}
```

### Get group

Get a group.

**Inputs**

- Group (`group_id`, text, required): Group id.

**Outputs**

- `data` (object): Talent LMS response data.

**Example output**

```json
{
  "data": {
    "_data": {
      "branch": {},
      "description": "example",
      "id": 1,
      "key": "example",
      "max_key_redemptions": 1,
      "name": "example",
      "price": {},
      "redemptions_sofar": 1
    }
  }
}
```

### Get health

Health check.

**Inputs**: None.

**Outputs**

- `data` (object): Talent LMS response data.

**Example output**

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

### Get user

Get a user.

**Inputs**

- Learner (`learner_id`, text, required): Learner id.

**Outputs**

- `data` (object): Talent LMS response data.

**Example output**

```json
{
  "data": {
    "_data": {
      "avatar": {
        "default": "example",
        "lg": "example",
        "md": "example",
        "sm": "example",
        "xl": "example"
      },
      "email": "example",
      "id": 1,
      "integration_user_id": "example",
      "language": "example",
      "last_login": "example",
      "last_updated": "example",
      "login": "example",
      "name": "example",
      "registration": "example",
      "status": "example",
      "surname": "example",
      "timezone": "example",
      "type": "example"
    }
  }
}
```

### List branches

List all branches.

**Inputs**

- Page number (`page_number`, number): Page number. From 1 to 100000.
- Page size (`page_size`, number): Page size. From 1 to 100.

**Outputs**

- `data` (object): Talent LMS response data.

**Example output**

```json
{
  "data": {
    "_data": [],
    "_meta": {
      "pagination": {
        "total_items": 1
      }
    }
  }
}
```

### List categories

List all categories.

**Inputs**

- Page number (`page_number`, number): Page number. From 1 to 100000.
- Page size (`page_size`, number): Page size. From 1 to 100.

**Outputs**

- `data` (object): Talent LMS response data.

**Example output**

```json
{
  "data": {
    "_data": [],
    "_meta": {
      "pagination": {
        "total_items": 1
      }
    }
  }
}
```

### List courses

List all courses.

**Inputs**

- Page number (`page_number`, number): Page number. From 1 to 100000.
- Page size (`page_size`, number): Page size. From 1 to 100.

**Outputs**

- `data` (object): Talent LMS response data.

**Example output**

```json
{
  "data": {
    "_data": [],
    "_meta": {
      "pagination": {
        "total_items": 1
      }
    }
  }
}
```

### List groups

List all groups.

**Inputs**

- Page number (`page_number`, number): Page number. From 1 to 100000.
- Page size (`page_size`, number): Page size. From 1 to 100.

**Outputs**

- `data` (object): Talent LMS response data.

**Example output**

```json
{
  "data": {
    "_data": [],
    "_meta": {
      "pagination": {
        "total_items": 1
      }
    }
  }
}
```

### List timeline

Get timeline.

**Inputs**

- Event type eq (`event_type_eq`, text): Event type eq.
- Created from gte (`created_from_gte`, date and time): Created from gte.
- Created to lte (`created_to_lte`, date and time): Created to lte.
- User id eq (`user_id_eq`, number): User id eq.
- Course id eq (`course_id_eq`, number): Course id eq.
- Branch id eq (`branch_id_eq`, number): Branch id eq.
- Group id eq (`group_id_eq`, number): Group id eq.
- Unit id eq (`unit_id_eq`, number): Unit id eq.
- Number (`page_number`, number): Number. From 1 to 100000.
- Size (`page_size`, number): Size. From 1 to 100.

**Outputs**

- `data` (object): Talent LMS response data.

**Example output**

```json
{
  "data": {
    "_data": [],
    "_links": {
      "first": "example",
      "last": "example",
      "next": "example",
      "prev": "example",
      "self": "example"
    },
    "_meta": {
      "filtered_by": {},
      "pagination": {
        "page": 1,
        "page_size": 1,
        "total_items": 1,
        "total_pages": 1,
        "total_results": 1
      }
    }
  }
}
```

### List users

Get users.

**Inputs**

- Status eq (`status_eq`, text): Status eq. One of: `active`, `inactive`.
- Login eq (`login_eq`, text): Login eq.
- Email eq (`email_eq`, text): Email eq.
- Keyword like (`keyword_like`, text): Keyword like.
- Last updated gte (`last_updated_gte`, date and time): Last updated gte.
- Last updated lte (`last_updated_lte`, date and time): Last updated lte.
- Branch id eq (`branch_id_eq`, number): Branch id eq.
- Group id eq (`group_id_eq`, number): Group id eq.
- Integration eq (`integration_eq`, text): Integration eq.
- Custom field value eq (`custom_field_value_eq`, text): Custom field value eq.
- Page number (`page_number`, number): Page number. From 1 to 100000.
- Page size (`page_size`, number): Page size. From 1 to 100.

**Outputs**

- `data` (object): Talent LMS response data.

**Example output**

```json
{
  "data": {
    "_data": [],
    "_links": {
      "first": "example",
      "last": "example",
      "next": "example",
      "prev": "example",
      "self": "example"
    },
    "_meta": {
      "pagination": {
        "page": 1,
        "page_size": 1,
        "total_items": 1,
        "total_pages": 1,
        "total_results": 1
      }
    }
  }
}
```

### Remove group member

Remove user from a group.

**Inputs**

- Learner (`learner_id`, text, required): The ID of the user to remove
- Group (`group_id`, text, required): The ID of the group

**Outputs**

- `data` (object): Talent LMS response data.

**Example output**

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

### Unenroll user

Delete a user from a course.

**Inputs**

- Learner (`learner_id`, text, required): The ID of the user to unenroll
- Course (`course_id`, text, required): The ID of the course

**Outputs**

- `data` (object): Talent LMS response data.

**Example output**

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

### Update user

Update a user.

**Inputs**

- Learner (`learner_id`, text, required): Learner id.
- Name (`name`, text): Name.
- Surname (`surname`, text): Surname.
- Login (`login`, text): Must be unique
- Email (`email`, text): Must be unique
- Password (`password`, text): Password.
- Description (`description`, text): Description.
- Timezone (`timezone`, text): A supported timezone name
- Locale (`locale`, text): Locale.
- Email notifications (`email_notifications`, true/false): Email notifications.
- User type id (`user_type_id`, text): User type id.
- Status (`status`, text): Omit to keep the current status. One of: `active`, `inactive`.
- Deactivation date (`deactivation_date`, date): Format YYYY-MM-DD. Cannot be in the past. Send an empty string to clear it
- Credits (`credits`, number): Credits. At least 0.

**Outputs**

- `data` (object): Talent LMS response data.

**Example output**

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