TalentLMS
App · 25 actions
Manage learners, courses, groups, branches and enrollments with the current TalentLMS API.
Actions
| Action | What it does |
|---|---|
| Add group member | Add a user to a group. |
| Create branch | Create a branch. |
| Create course | Create course. |
| Create group | Create a group. |
| Create user | Create a user. |
| Delete branch | Delete a branch. |
| Delete course | Delete a course. |
| Delete group | Delete a group. |
| Delete user | Delete a user. |
| Enroll user | Enroll user to course. |
| Get branch | Get a branch. |
| Get course | Get a course. |
| Get course progress | Get user's course progress. |
| Get group | Get a group. |
| Get health | Health check. |
| Get user | Get a user. |
| List branches | List all branches. |
| List categories | List all categories. |
| List courses | List all courses. |
| List groups | List all groups. |
| List timeline | Get timeline. |
| List users | Get users. |
| Remove group member | Remove user from a group. |
| Unenroll user | Delete a user from a course. |
| Update user | Update a user. |
Add group member
Add a user to a group.
Inputs
- Group
group_idtextRequired - Group id.
- Learner
learner_idtextRequired - Learner id.
- Enroll to courses
enroll_to_coursestrue/false - Whether to force synchronous enrollment in the group's active coursesDefault:
false.
Outputs
dataobject- Talent LMS response data.
Example output
{
"data": {}
}Create branch
Create a branch.
Inputs
- Name
nametextRequired - Name.
- Description
descriptiontext - Description.
- Default locale
default_localetext - Default locale.
Outputs
dataobject- Talent LMS response data.
Example output
{
"data": {
"_data": {
"email": "example",
"id": 1,
"login": "example",
"name": "example"
}
}
}Create course
Create course.
Inputs
- Name
nametextRequired - Name.
- Code
codetext - Code.
- Description
descriptiontext - Description.
- Category
category_idtext - Category id.
- Price
pricenumber - Price.
- Capacity
capacitynumber - Capacity.
- Level
levelnumber - Level.
- Time limit
time_limitnumber - Time limit.
- Is active
is_activetrue/false - Is active.
- Custom fields
custom_fieldsobject - Custom fields.
Outputs
dataobject- Talent LMS response data.
Example output
{
"data": {
"_data": {
"email": "example",
"id": 1,
"login": "example",
"name": "example"
}
}
}Create group
Create a group.
Inputs
- Name
nametextRequired - Name.
- Description
descriptiontext - Description.
- Key
keytext - Key.
- Max key redemptions
max_key_redemptionsnumber - Max key redemptions.
- Price
pricenumber - Price.
Outputs
dataobject- Talent LMS response data.
Example output
{
"data": {
"_data": {
"email": "example",
"id": 1,
"login": "example",
"name": "example"
}
}
}Create user
Create a user.
Inputs
- Name
nametextRequired - Name.
- Surname
surnametextRequired - Surname.
- Login
logintextRequired - Login.
- Email
emailtextRequired - Email.
- Timezone
timezonetext - Timezone.
- Locale
localetext - Locale.
- Email notifications
email_notificationstrue/false - Email notifications.
- User type id
user_type_idtext - User type id.
- Status
statustrue/false - Status.
- Password
passwordtextRequired - Password.
- Description
descriptiontext - Description.
- Credits
creditsnumber - Credits.
- Deactivation date
deactivation_datedate - Deactivation date.
Outputs
dataobject- Talent LMS response data.
Example output
{
"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_idtextRequired - Branch id.
Outputs
dataobject- Talent LMS response data.
Example output
{
"data": {}
}Delete course
Delete a course.
Inputs
- Course
course_idtextRequired - Course id.
Outputs
dataobject- Talent LMS response data.
Example output
{
"data": {}
}Delete group
Delete a group.
Inputs
- Group
group_idtextRequired - Group id.
Outputs
dataobject- Talent LMS response data.
Example output
{
"data": {}
}Delete user
Delete a user.
Inputs
- Learner
learner_idtextRequired - Learner id.
- Permanent
permanenttrue/false - Permanent.Default:
false.
Outputs
dataobject- Talent LMS response data.
Example output
{
"data": {}
}Enroll user
Enroll user to course.
Inputs
- Course
course_idtextRequired - Course id.
- Learner
learner_idtextRequired - Learner id.
Outputs
dataobject- Talent LMS response data.
Example output
{
"data": {}
}Get branch
Get a branch.
Inputs
- Branch
branch_idtextRequired - Branch id.
Outputs
dataobject- Talent LMS response data.
Example output
{
"data": {
"_data": {
"email": "example",
"id": 1,
"login": "example",
"name": "example"
}
}
}Get course
Get a course.
Inputs
- Course
course_idtextRequired - Course id.
Outputs
dataobject- Talent LMS response data.
Example output
{
"data": {
"_data": {
"email": "example",
"id": 1,
"login": "example",
"name": "example"
}
}
}Get course progress
Get user's course progress.
Inputs
- Learner
learner_idtextRequired - Learner id.
- Course
course_idtextRequired - Course id.
Outputs
dataobject- Talent LMS response data.
Example output
{
"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_idtextRequired - Group id.
Outputs
dataobject- Talent LMS response data.
Example output
{
"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
dataobject- Talent LMS response data.
Example output
{
"data": {}
}Get user
Get a user.
Inputs
- Learner
learner_idtextRequired - Learner id.
Outputs
dataobject- Talent LMS response data.
Example output
{
"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_numbernumber - Page number.From 1 to 100000.
- Page size
page_sizenumber - Page size.From 1 to 100.
Outputs
dataobject- Talent LMS response data.
Example output
{
"data": {
"_data": [],
"_meta": {
"pagination": {
"total_items": 1
}
}
}
}List categories
List all categories.
Inputs
- Page number
page_numbernumber - Page number.From 1 to 100000.
- Page size
page_sizenumber - Page size.From 1 to 100.
Outputs
dataobject- Talent LMS response data.
Example output
{
"data": {
"_data": [],
"_meta": {
"pagination": {
"total_items": 1
}
}
}
}List courses
List all courses.
Inputs
- Page number
page_numbernumber - Page number.From 1 to 100000.
- Page size
page_sizenumber - Page size.From 1 to 100.
Outputs
dataobject- Talent LMS response data.
Example output
{
"data": {
"_data": [],
"_meta": {
"pagination": {
"total_items": 1
}
}
}
}List groups
List all groups.
Inputs
- Page number
page_numbernumber - Page number.From 1 to 100000.
- Page size
page_sizenumber - Page size.From 1 to 100.
Outputs
dataobject- Talent LMS response data.
Example output
{
"data": {
"_data": [],
"_meta": {
"pagination": {
"total_items": 1
}
}
}
}List timeline
Get timeline.
Inputs
- Event type eq
event_type_eqtext - Event type eq.
- Created from gte
created_from_gtedate and time - Created from gte.
- Created to lte
created_to_ltedate and time - Created to lte.
- User id eq
user_id_eqnumber - User id eq.
- Course id eq
course_id_eqnumber - Course id eq.
- Branch id eq
branch_id_eqnumber - Branch id eq.
- Group id eq
group_id_eqnumber - Group id eq.
- Unit id eq
unit_id_eqnumber - Unit id eq.
- Number
page_numbernumber - Number.From 1 to 100000.
- Size
page_sizenumber - Size.From 1 to 100.
Outputs
dataobject- Talent LMS response data.
Example output
{
"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_eqtext - Status eq.One of:
active,inactive. - Login eq
login_eqtext - Login eq.
- Email eq
email_eqtext - Email eq.
- Keyword like
keyword_liketext - Keyword like.
- Last updated gte
last_updated_gtedate and time - Last updated gte.
- Last updated lte
last_updated_ltedate and time - Last updated lte.
- Branch id eq
branch_id_eqnumber - Branch id eq.
- Group id eq
group_id_eqnumber - Group id eq.
- Integration eq
integration_eqtext - Integration eq.
- Custom field value eq
custom_field_value_eqtext - Custom field value eq.
- Page number
page_numbernumber - Page number.From 1 to 100000.
- Page size
page_sizenumber - Page size.From 1 to 100.
Outputs
dataobject- Talent LMS response data.
Example output
{
"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_idtextRequired - The ID of the user to remove
- Group
group_idtextRequired - The ID of the group
Outputs
dataobject- Talent LMS response data.
Example output
{
"data": {}
}Unenroll user
Delete a user from a course.
Inputs
- Learner
learner_idtextRequired - The ID of the user to unenroll
- Course
course_idtextRequired - The ID of the course
Outputs
dataobject- Talent LMS response data.
Example output
{
"data": {}
}Update user
Update a user.
Inputs
- Learner
learner_idtextRequired - Learner id.
- Name
nametext - Name.
- Surname
surnametext - Surname.
- Login
logintext - Must be unique
- Email
emailtext - Must be unique
- Password
passwordtext - Password.
- Description
descriptiontext - Description.
- Timezone
timezonetext - A supported timezone name
- Locale
localetext - Locale.
- Email notifications
email_notificationstrue/false - Email notifications.
- User type id
user_type_idtext - User type id.
- Status
statustext - Omit to keep the current statusOne of:
active,inactive. - Deactivation date
deactivation_datedate - Format YYYY-MM-DD. Cannot be in the past. Send an empty string to clear it
- Credits
creditsnumber - Credits.At least 0.
Outputs
dataobject- Talent LMS response data.
Example output
{
"data": {}
}