API
Reports API
block_configurable_reports_get_report_data Arguments reportid (Required) The report id General structure int //The report id REST (POST parameters) reportid= int How to connect to 3rd party data analysis tools: You can also connect to tools like: ...
Course API
core_course_get_courses Arguments options (Default to "Array ( ) ") options - operator OR is used General structure Default to "Array ( ) " //options - operator OR is used object { ids Optional //List of course id. If empty return all ...
SCORM API
mod_scorm_get_scorm_user_data Arguments scormid (Required) scorm instance id General structure int //scorm instance id REST (POST parameters) scormid= int attempt (Required) attempt number General structure int //attempt number REST (POST parameters) ...
Creating a Webhook
With the Pluto LMS API (see functions), you will be able to create webhooks within your custom application. What are Webhooks? A webhook is triggered by events rather than requests. A webhook allows one software application to send data to another as ...
User API
core_user_create_users Arguments users (Required) General structure list of ( object { createpassword int Optional //True if password should be created and mailed to user. username string //Username of profile. auth string Default to "manual" ...
Messaging API
core_message_get_messages Arguments useridto (Required) the user id who received the message, 0 for any user. useridfrom (Default to "0") the user id who send the message, 0 for any user. Note that a useridto=0 and useridfrom=0, will not work. At ...
Course Groups API
core_group_add_group_members Arguments members (Required) General structure list of ( object { groupid int //group record id userid int //user id } ) REST (POST parameters) members[0][groupid]= int members[0][userid]= int ...
Grades API
gradereport_overview_get_course_grades Arguments userid (Default to "0") Get grades for this user (optional, default current) General structure int Default to "0" //Get grades for this user (optional, default current) REST (POST parameters) ...
Enrollment API
enrol_manual_enrol_users Arguments enrolments (Required) General structure list of ( object { roleid int //Role to assign to the user userid int //The user that is going to be enrolled courseid int //The course to enrol the user role in ...
Course Completion API
core_completion_get_activities_completion_status Arguments courseid (Required) Course ID General structure int //Course ID REST (POST parameters) courseid= int userid (Required) User ID General structure int //User ID REST (POST ...
Branches API
core_cohort_add_cohort_members Arguments members (Required) General structure list of ( object { cohorttype object { type string //The name of the field: id (numeric value of cohortid) or idnumber (alphanumeric value of idnumber) ...
Calendar API
core_calendar_create_calendar_events Arguments events (Required) General structure list of ( //event object { name string //event name description string Default to "null" //Description format int Default to "1" //description format (1 = HTML, ...
Setting Up Your API
We advise the use of a developer to help you setup your API connection. We will offer an example of how to CREATE NEW USER on your LMS (core_user_create_users) Let's review only the required REST (POST parameters): wsfunction=core_user_create_users ...
Generate your API Key
Step 1: Click on "Site admin" > "Integrations" > "Manage tokens": Step 2: Click on "Create Token": Step 3: (1) Select the user you wish to give the API Token to, (2) Select "API" then (3) Save: Step 4: Share this token with the user or save it if ...
Finding Pluto LMS IDs
USER IDS To find a User ID: Go to "Site admin" → "User Management" → "View all site users", then select the applicable User Profile. The ID can be found in the browser URL: COURSE IDS To find a Course ID: Go to the applicable Course. The ID can be ...
Popular Articles
Understanding the Pluto LMS Support Scope
We love our clients and place high priority on providing the best possible customer support. Channels of Support There are multiple channels of support and, as such, an important part of providing our clients with responsive and comprehensive support ...
Create a Single Course
OVERVIEW Users with the "Site Admin" or "Course Creator" roles can create new courses and define course settings. CREATE A COURSE Step 1: Click on "Create course" in your left navigation menu. Alternatively, you click on "Site admin", followed by ...
Video Tutorials
Watch Our YouTube Playlist Below You can select and navigate to individual videos from the top right icon. If you would prefer to watch this on YouTube, click here .
Reports API
block_configurable_reports_get_report_data Arguments reportid (Required) The report id General structure int //The report id REST (POST parameters) reportid= int How to connect to 3rd party data analysis tools: You can also connect to tools like: ...
Create Course Categories
OVERVIEW Course categories organize courses for all your LMS users. CREATE COURSE CATEGORIES Step 1: Click on "Site admin", followed by "Course management", then "Create category." Step 2: Define your category settings. (1) Set "Parent category" as ...