FoundationLMS
Foundation LMS is purpose-built for the continuing education industry, empowering you to deliver world-class education while ensuring compliance with accrediting bodies
FoundationLMS endpoints
| Method | Endpoint | Description |
|---|---|---|
| authentication | ||
| POST |
login /v1/login |
|
| POST |
forgot-password /v1/forgot-password |
Handles the forgot password functionality by validating the email input, finding the user associated with the provided email and client ID, and sending a password reset link if… |
| POST |
logout /v1/logout |
Handles the user logout functionality by revoking all issued tokens associated with the currently authenticated user and returns a success response. |
| cashier | ||
| POST |
validate-promo-code /v1/cashier/validate-promo-code |
check promo code |
| clients | ||
| GET |
custom fields /v1/custom-fields |
Retrieve and process custom fields from client settings. |
| POST |
register new client /v1/client/register |
register new client |
| Companies | ||
| GET |
company details /v1/company/details |
Retrieves the details of the current company or client. |
| POST |
update company details /v1/company/update |
updates the details of a company using the validated data from the request |
| Courses | ||
| GET |
coupons list /v1/courses/coupons |
Display a paginated listing or the resource |
| POST |
add new coupons /v1/courses/coupons |
Validates the incoming coupon request data and integrates with the Stripe API to create the coupon. Depending on the discount type, it processes the respective data such as… |
| GET |
display coupons /v1/courses/coupons/{id} |
Verifies the user's permission to view coupons and validates the provided coupon ID. Attempts to retrieve the coupon from the repository using a parsable MongoDB ID. Responds… |
| PUT |
update new coupons /v1/courses/coupons/{id} |
Validates the incoming update request, confirms the validity of the coupon ID, and fetches the corresponding coupon resource. Integrates with the Stripe API to update the… |
| DELETE |
delete coupons /v1/courses/coupons/{id} |
Validates the given coupon ID and ensures it is parsable by MongoDB before proceeding. Retrieves the coupon from the database and verifies its existence. Integrates with the… |
| GET |
get course curriculumn /v1/courses/{id}/curriculum |
List curriculumn under course |
| GET |
get course module details /v1/courses/{id}/module/{module_id} |
Get Course Module Details |
| GET |
get course activity details /v1/courses/{id}/activity/{activity_id} |
get course activity details |
| GET |
get course game details /v1/courses/{id}/game/{game_id} |
get course game details |
| GET |
get course questions list /v1/courses/{id}/questions |
get course questions list |
| GET |
get course survey questions /v1/courses/{id}/survey |
get course survey questions |
| GET |
get course follow up questions /v1/courses/{id}/followup-survey |
get course follow up questions |
| GET |
get course certificate listing /v1/courses/{id}/certificates |
get course certificate listing |
| GET |
get the certificate issuance report for a course. /v1/courses/{id}/certificate-report?from=2026-01-01&to=2026-06-30&quarter=Q1&year=2026 |
get the certificate issuance report for a course. |
| GET |
get student curriculum status for a course. /v1/courses/{id}/curriculum-status |
get student curriculum status for a course. |
| GET |
get course status, degree and specialty summary. /v1/courses/{id}/status-degree-specialty-summary?from=2026-01-01&to=2026-06-30&quarter=Q1&year=2026&breakdown=degree&group_by=specialty |
Returns student enrollment status counts, demographic summaries, and completion rates for a course. |
| GET |
get the academic versus community hospital enrollment summary for a course. /v1/courses/{id}/academy-vs-community?from=2026-01-01&to=2026-06-30&quarter=Q1&year=2026 |
get the academic versus community hospital enrollment summary for a course. |
| GET |
get course pretest and posttest summary. /v1/courses/{id}/pretest-posttest-report?from=2026-01-01&to=2026-06-30&quarter=Q1&year=2026 |
Returns aggregated correct, wrong, total, percentage, choices, and rationale values for pretest and posttest answers. |
| GET |
get survey and follow up survey results grouped by question. /v1/courses/{id}/survey-followup-survey-report?from=2026-01-01&to=2026-06-30&quarter=Q1&year=2026 |
Returns the number of student answers for every survey and follow-up survey question. Label-type questions (informational text with no answer) are excluded from the report.… |
| GET |
get course geographic summary breakdown /v1/courses/{id}/geographic-summary |
Returns global, US, and US states student enrollment and completion breakdown by course and enrolled students. |
| GET |
get list of courses /v1/courses?page=2 |
Display a listing of the resource |
| POST |
store a newly created course /v1/courses |
store a newly created course |
| GET |
display course details /v1/courses/{id} |
display course details |
| PUT |
Update Course /v1/courses/{id} |
Update Course |
| POST |
Update the status of the specified course. /v1/courses/{id}/update-status |
Update the status of the specified course. |
| POST |
Register Student /v1/student-register |
Register Student |
| POST |
Handles the student enrollment process for a specific course. /v1/student/enroll |
Handles the student enrollment process for a specific course. |
| Faculties | ||
| GET |
retrieve a list of faculties /v1/faculty |
retrieve a list of faculties |
| POST |
store new faculty /v1/faculty |
retrieve a list of faculties |
| GET |
Display the specified faculty details /v1/faculty/{id} |
Display the specified faculty details |
| PUT |
update faculty /v1/faculty/{id} |
update faculty |
| DELETE |
Delete Faculty /v1/faculty/{id} |
Delete Faculty |
| Users | ||
| GET |
Display a listing of users /v1/users |
Display a listing of users |
| POST |
Store new users in the db /v1/users |
This method validates the incoming request data and ensures that the authenticated user has permission to add a user. It checks the validity of the provided role ID, prepares the… |
| GET |
Get user Details /v1/users/{id} |
Get user Details |
| PUT |
Update user info /v1/users/{id} |
This method validates the incoming request data and ensures that the authenticated user has permission to update a user. It checks the validity of the provided role ID, prepares… |
| DELETE |
Delete user /v1/users/{id} |
Delete user |
FoundationLMS pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | $0.01 / month | — |
|