Available Litmos APIs

Rachel Shanthi Bijja

Updated November 26, 2024 16:34

When you configure an export, import, or other type of flow step using the prebuilt Litmos connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Litmos API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource	API endpoint	Export	Import
Achievements	List achievements	X
Course custom fields	Get all course custom fields	X
	Get course custom field details based on custom field ID	X
	Get custom fields for a course	X
Courses	List courses	X
	Get a course	X
	List users assigned to a course	X
Users	Get user list	X
	Get user	X
	Get user by username	X
	Get advanced user custom fields (non-legacy)	X
	List courses assigned to a user	X
	List all user results for a course	X
	List modules for a course	X
	List course and module results for a user	X
	List all course results for all users since a specific date	X
	Create user		X
	Assign courses to a user		X
	Remove all teams from a user		X
	Update user		X
	Delete user		X
	Post advanced user custom fields (non-legacy)		X
	Remove courses from a user		X
	Users-reset course results for a learner		X
Teams	Get team list	X
	Get sub team list	X
	Get team	X
	Get users in a team	X
	Get a list of all teams a user is assigned to	X
	Get team leaders for a team	X
	Get team admins for a team	X
	List team courses	X
	Create team		X
	Create sub-team		X
	Update team		X
	Delete team		X
	Assign courses		X
	Unassign courses		X
	Assign users to a team		X
	Remove a user from a team		X
	Remove a user from all teams the user is assigned to		X
	Promote a user to team leader		X
	Promote a user to team admin		X
	Remove a team leader from a team		X
	Remove a team admin from a team		X
Learning paths	Get learning paths	X
	Get a learning path	X
	Get learning path courses	X
	Get learning path users	X
	Get learning paths assigned to a specific user	X
	Get all learning paths assigned to a team	X
	Request to assign users to a learning path		X
	Delete a user from a learning path		X
	Assign learning paths to a team		X
	Delete learning paths from a team		X
Instructor lead training	Get future session list	X
	Get past session list	X
	Get ILT modules in a course	X
	Get session list in a module	X
	Get session	X
	Get instructor list	X
	Get session list for an instructor	X
	Get session roll call	X
	Get session registration	X
	Register user to session		X
	Mark attendance		X
	Mark attendance of user list		X
	Get attendance		X
	Create session		X
	Update session		X
	Mark session complete and add score		X
	Delete a session		X
	Delete an ILT module		X
Gamification	Get total badges and points for user	X
	Get list of badges earned by user	X
	Get badges and points earned by user	X
	Get badges and points earned by team	X
	Reset gamification for a user		X
Date range	Get user details	X
	Get results	X
	Get achievements	X
	Get courses	X
	Get learning paths	X
	Get courses and modules	X
	Get courses and learning paths	X
	Get user course assignments	X
	Get user learning path assignments	X
	Get teams	X
	Get team users assigned	X
	Get team courses assigned	X
	Get team learning paths assigned	X
	Get modules	X
	Get modules results	X
	Get learning paths results	X
Mark a module complete	Mark a module complete		X