API
Course API
core_course_get_courses This function retrieves details about one or more courses. Let's review the POST parameters for this function: Optional Parameter: options[ids][0]= int (Optional: A numeric course ID. You can pass multiple IDs to retrieve ...
SCORM API
mod_scorm_get_scorm_user_data This function retrieves detailed user tracking data for a specific attempt on a SCORM package. Let's review the POST parameters for this function: Required Parameters: scormid= int (Required: The numeric instance ID of ...
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 We advise the use of a developer to help you setup your API connection. This example shows how to create new users. Let's review the POST parameters for this function: Required Parameters: users[0][username]= string (Required: ...
Messaging API
core_message_get_messages This function retrieves messages for a user. You can get all messages sent to a user, or get the conversation between two specific users. Let's review the POST parameters for this function: Parameters: useridto= int ...
Course Groups API
core_group_add_group_members This function adds one or more users to a specific group within a course. Let's review the POST parameters for this function: Required Parameters: members[0][groupid]= int (Required: The numeric ID of the group.) ...
Grades API
gradereport_overview_get_course_grades This function retrieves an overview of all final course grades for a specific user. Let's review the POST parameters for this function: Optional Parameter: userid= int (Optional: The numeric ID of the user. If ...
Enrollment API
enrol_manual_enrol_users This function manually enrols one or more users into a specified course with a specific role. Let's review the POST parameters for this function: Required Parameters: enrolments[0][roleid]= int (Required: The numeric ID for ...
Course Completion API
core_completion_get_activities_completion_status This function checks the completion status of all activities within a course for a specific user. Let's review the POST parameters for this function: Required Parameters: courseid= int (Required: The ...
User Segments API
Note: In this system, a "Cohort" is a group of users, similar to a "User Segment". core_cohort_add_cohort_members This function adds one or more users to a specified cohort. Let's review the POST parameters for this function: Required Parameters: The ...
Calendar API
core_calendar_create_calendar_events This function is used to create new calendar events. You can create events for a user, a course, or a group. Let's review the POST parameters for this function: Required Parameters: events[0][name]= string ...
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 A NEW USER on your LMS using a cURL command. Let's review the required POST parameters for the core_user_create_users function: ...
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 ...