TalentLMS

App · 25 actions

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

Actions

ActionWhat it does
Add group memberAdd a user to a group.
Create branchCreate a branch.
Create courseCreate course.
Create groupCreate a group.
Create userCreate a user.
Delete branchDelete a branch.
Delete courseDelete a course.
Delete groupDelete a group.
Delete userDelete a user.
Enroll userEnroll user to course.
Get branchGet a branch.
Get courseGet a course.
Get course progressGet user's course progress.
Get groupGet a group.
Get healthHealth check.
Get userGet a user.
List branchesList all branches.
List categoriesList all categories.
List coursesList all courses.
List groupsList all groups.
List timelineGet timeline.
List usersGet users.
Remove group memberRemove user from a group.
Unenroll userDelete a user from a course.
Update userUpdate a user.

Add group member

Add a user to a group.

Inputs

Groupgroup_idtextRequired
Group id.
Learnerlearner_idtextRequired
Learner id.
Enroll to coursesenroll_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

NamenametextRequired
Name.
Descriptiondescriptiontext
Description.
Default localedefault_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

NamenametextRequired
Name.
Codecodetext
Code.
Descriptiondescriptiontext
Description.
Categorycategory_idtext
Category id.
Pricepricenumber
Price.
Capacitycapacitynumber
Capacity.
Levellevelnumber
Level.
Time limittime_limitnumber
Time limit.
Is activeis_activetrue/false
Is active.
Custom fieldscustom_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

NamenametextRequired
Name.
Descriptiondescriptiontext
Description.
Keykeytext
Key.
Max key redemptionsmax_key_redemptionsnumber
Max key redemptions.
Pricepricenumber
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

NamenametextRequired
Name.
SurnamesurnametextRequired
Surname.
LoginlogintextRequired
Login.
EmailemailtextRequired
Email.
Timezonetimezonetext
Timezone.
Localelocaletext
Locale.
Email notificationsemail_notificationstrue/false
Email notifications.
User type iduser_type_idtext
User type id.
Statusstatustrue/false
Status.
PasswordpasswordtextRequired
Password.
Descriptiondescriptiontext
Description.
Creditscreditsnumber
Credits.
Deactivation datedeactivation_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

Branchbranch_idtextRequired
Branch id.

Outputs

dataobject
Talent LMS response data.
Example output
{
  "data": {}
}

Delete course

Delete a course.

Inputs

Coursecourse_idtextRequired
Course id.

Outputs

dataobject
Talent LMS response data.
Example output
{
  "data": {}
}

Delete group

Delete a group.

Inputs

Groupgroup_idtextRequired
Group id.

Outputs

dataobject
Talent LMS response data.
Example output
{
  "data": {}
}

Delete user

Delete a user.

Inputs

Learnerlearner_idtextRequired
Learner id.
Permanentpermanenttrue/false
Permanent.Default: false.

Outputs

dataobject
Talent LMS response data.
Example output
{
  "data": {}
}

Enroll user

Enroll user to course.

Inputs

Coursecourse_idtextRequired
Course id.
Learnerlearner_idtextRequired
Learner id.

Outputs

dataobject
Talent LMS response data.
Example output
{
  "data": {}
}

Get branch

Get a branch.

Inputs

Branchbranch_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

Coursecourse_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

Learnerlearner_idtextRequired
Learner id.
Coursecourse_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

Groupgroup_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

Learnerlearner_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 numberpage_numbernumber
Page number.From 1 to 100000.
Page sizepage_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 numberpage_numbernumber
Page number.From 1 to 100000.
Page sizepage_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 numberpage_numbernumber
Page number.From 1 to 100000.
Page sizepage_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 numberpage_numbernumber
Page number.From 1 to 100000.
Page sizepage_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 eqevent_type_eqtext
Event type eq.
Created from gtecreated_from_gtedate and time
Created from gte.
Created to ltecreated_to_ltedate and time
Created to lte.
User id equser_id_eqnumber
User id eq.
Course id eqcourse_id_eqnumber
Course id eq.
Branch id eqbranch_id_eqnumber
Branch id eq.
Group id eqgroup_id_eqnumber
Group id eq.
Unit id equnit_id_eqnumber
Unit id eq.
Numberpage_numbernumber
Number.From 1 to 100000.
Sizepage_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 eqstatus_eqtext
Status eq.One of: active, inactive.
Login eqlogin_eqtext
Login eq.
Email eqemail_eqtext
Email eq.
Keyword likekeyword_liketext
Keyword like.
Last updated gtelast_updated_gtedate and time
Last updated gte.
Last updated ltelast_updated_ltedate and time
Last updated lte.
Branch id eqbranch_id_eqnumber
Branch id eq.
Group id eqgroup_id_eqnumber
Group id eq.
Integration eqintegration_eqtext
Integration eq.
Custom field value eqcustom_field_value_eqtext
Custom field value eq.
Page numberpage_numbernumber
Page number.From 1 to 100000.
Page sizepage_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

Learnerlearner_idtextRequired
The ID of the user to remove
Groupgroup_idtextRequired
The ID of the group

Outputs

dataobject
Talent LMS response data.
Example output
{
  "data": {}
}

Unenroll user

Delete a user from a course.

Inputs

Learnerlearner_idtextRequired
The ID of the user to unenroll
Coursecourse_idtextRequired
The ID of the course

Outputs

dataobject
Talent LMS response data.
Example output
{
  "data": {}
}

Update user

Update a user.

Inputs

Learnerlearner_idtextRequired
Learner id.
Namenametext
Name.
Surnamesurnametext
Surname.
Loginlogintext
Must be unique
Emailemailtext
Must be unique
Passwordpasswordtext
Password.
Descriptiondescriptiontext
Description.
Timezonetimezonetext
A supported timezone name
Localelocaletext
Locale.
Email notificationsemail_notificationstrue/false
Email notifications.
User type iduser_type_idtext
User type id.
Statusstatustext
Omit to keep the current statusOne of: active, inactive.
Deactivation datedeactivation_datedate
Format YYYY-MM-DD. Cannot be in the past. Send an empty string to clear it
Creditscreditsnumber
Credits.At least 0.

Outputs

dataobject
Talent LMS response data.
Example output
{
  "data": {}
}

On this page