A Complete List of the LearnPress Rest API

LearnPress - By Sally Do - June 13, 2023

Do you need the full list of the LearnPress Rest API for the latest version? If yes, you are in the right place.

LearnPress is the most famous LMS WordPress plugin that assists you in building a complete learning management system website. Moreover, there are free and premium LearnPress add-ons to add more features to your eLearning sites.

Since LearnPress comes with version 4.0, we’ll provide you with the newest full list of LearnPress Rest API. Surely, it’s useful for developers, enabling seamless integration and communication between different applications and services.

With this LearnPress Rest API list, you can build your own Mobile App that syncs data with the website, helping students conveniently study anytime, anywhere. If you are interested in Mobile App, you can refer to the version that we have built.

Your First Steps with LearnPresss

Before diving into the LearnPress REST API list, it’s essential to know the basics of LearnPress and how it works.

Read more:  Solution for Building a Multilingual Online Course Website: 6 Simple Steps

What is LearnPress?

LearnPress 4
What is LearnPress 4.0?

As previously stated, LearnPress is among the most famous WordPress plugins designed to assist users in creating LMS websites for creating and selling online courses.

LearnPress Official Documentation

If you want to create a Learning Management Website with LearnPress, you can find our LearnPress official documentation and our tips to read LearnPress documentation. It includes user guides and tutorials, helping you to get started quickly. Plus, you can use the wiki as well.

LearnPress Support and Community

If you have issues while using LearnPress, go to the support forum to seek help. You can also join our private Facebook group to connect with other users and share feedback. For assistance with premium add-ons, visit the helpdesk.

Reporting Bugs and Contributing to LearnPress

If you discover any bugs, you can report them on our support forum or GitHub repository. You can also help the project by signing up for the GitHub repository.

LearnPress Add-Ons

LearnPress has a number of add-ons that can be used to enhance the functionality of your LMS site. From payment gateways to certification, these add-ons help enhance your e-learning platform and deliver a better user experience.

Introduction to LearnPress REST API in 4.0

The LearnPress REST API is specifically designed to extend the capabilities of your LearnPress Learning Management System (LMS). Here’s what it unlocks:

  • External Access: Interact with your LearnPress data from outside the main website (e.g., mobile apps, third-party integrations).
  • Automation: Automate tasks like course enrollment, quiz grading, or user management.
  • Customization: Build custom front-ends or unique learning experiences on top of the LearnPress platform.
Read more:  Image Alt Text: What You Need to Know

The API provides endpoints (specific URLs) to work with:

  • Courses: Create, update, retrieve, and delete courses.
  • Lessons: Manage lesson content within courses.
  • Quizzes: Create and manage quizzes, questions, and results.
  • Users: Handle user registration, enrollment, and progress tracking.
  • Orders: Manage purchases of courses and other LearnPress products.

LearnPress REST API Endpoints

The LearnPress REST API offers a variety of endpoints, allowing developers to interact with different resources. Let’s see the most commonly used endpoints:

Courses

The courses endpoint enables you to manage the courses available on your LMS website. You can CRUD courses as well as retrieve course information, such as the curriculum, prerequisites, and assessments.

Lessons

The lessons endpoint allows you to manage the individual lessons within a course. You can CRUD lessons as well as retrieve lesson content, attachments, and quiz information.

Quizzes

The quizzes endpoint enables you to manage the quizzes associated with your lessons. You can CRUD quizzes as well as retrieve quiz questions, options, and correct answers.

Users

The user’s endpoint allows you to manage the users on your LMS website. You can CRUD users as well as retrieve user information, such as enrollment status, course progress, and quiz results.

Orders

The orders endpoint enables you to manage the orders placed on your LMS website. You can CRUD orders as well as retrieve order information, such as payment status, transaction details, and user information.

A Complete List of the LearnPress Rest API

Here’s a complete list of available LearnPress Rest APIs that can be useful for you.

Let’s check it!

Get Token

POST: /wp-json/learnpress/v1/token

Parameter:

  • username: string
  • password: string

Validate Token

POST: /wp-json/learnpress/v1/token/validate

List All Course

GET: /wp-json/learnpress/v1/courses

Parameter:

  • context : string
  • page: integer
  • per_page: integer
  • search: string
  • after: string
  • before: string
  • exclude: array
  • include : array
  • offset: integer
  • order: string
  • orderby: string
  • category: string
  • tag: string
Read more:  Build Community Using LearnPress bbPress Integration

Retrieve A Course

GET: /wp-json/learnpress/v1/courses/id_course

List All Lessons on The Website

GET: /wp-json/learnpress/v1/lessons

Parameter:

  • context : string
  • page: integer
  • per_page: integer
  • search: string
  • after: string
  • before: string
  • exclude: array
  • include : array
  • offset: integer
  • order: string
  • orderby: string

Retrieve A Lesson by ID

GET: /wp-json/learnpress/v1/lessons/id

Parameter: 

  • context: string
  • page: integer
  • per_page: integer
  • search: string
  • after: string
  • before: string
  • exclude: array
  • include: array
  • offset: integer
  • order: string
  • orderby: string

List All Quizzes on The Website

GET: /wp-json/learnpress/v1/quiz

Parameter: 

  • context: string
  • page: integer
  • per_page: integer
  • search: string
  • after: string
  • before: string
  • exclude: array
  • include: array
  • offset: integer
  • order: string
  • orderby: string

Retrieve A Quiz by ID

GET: /wp-json/learnpress/v1/quiz/id

Parameter: 

  • context: string
  • page: integer
  • per_page: integer
  • search: string
  • after: string
  • before: string
  • exclude: array
  • include: array
  • offset: integer
  • order: string
  • orderby: string

List All Users on The Website

GET: /wp-json/learnpress/v1/users/

Parameter: 

  • exclude: array
  • include: array
  • offset: integer
  • order: string
  • orderby: string
  • slug: array
  • roles: array
  • who: string

List All My Courses

GET: wp-json/learnpress/v1/courses/?learned=true

Parameter: 

  • context: string
  • page: integer
  • per_page: integer
  • search: string
  • after: string
  • before: string
  • exclude: array
  • include: array
  • offset: integer
  • order: string
  • orderby: string
  • category: string
  • tag: string
  • course_filter (in-progress, passed, failed): string

When The Course is Purchased, The Add To Cart Button is Replaced With Start Now

POST: /wp-json/learnpress/v1/courses/enroll

Parameter: 

  • id: integer

Finish Course

POST: /wp-json/learnpress/v1/courses/finish

Parameter: 

  • id: integer

Retake Course

POST: /wp-json/learnpress/v1/courses/retake

Parameter: 

  • id: integer

Finish Lesson

POST: /wp-json/learnpress/v1/lessons/finish

Parameter: 

  • id: integer

Start Quiz

POST: /wp-json/learnpress/v1/quiz/start

Parameter: 

  • id: integer

Check Answer

POST: /wp-json/learnpress/v1/quiz/check_answer

Parameter: 

  • id: integer
  • answered: string

Finish Quiz

POST: /wp-json/learnpress/v1/quiz/finish

Parameter: 

  • id: integer
  • answered: object

Retrieve Course Category

GET: /wp-json/wp/v2/course_category

API for Assignment

It requires to install the Assignment plugin to get the API.

Get All Assignment

GET: /wp-json/learnpress/v1/assignments/

Parameter: 

  • context: string
  • page: integer
  • per_page: integer
  • search: string
  • after: string
  • before: string
  • exclude: array
  • include: array
  • offset: integer
  • order: string
  • orderby: string

Get An Assignment by ID

GET: /wp-json/learnpress/v1/assignments/id

Start Assignment

POST: /wp-json/learnpress/v1/assignments/start/

Parameter: 

  • id: integer

Retake Assignment

POST: /wp-json/learnpress/v1/assignments/retake/

Parameter: 

  • id: integer

Save/Send Assignment

POST: /wp-json/learnpress/v1/assignments/submit/ Content type: form-data

Parameter:

  • action: string
  • id: integer
  • note: string
  • file: array

Delete Saved File

POST: /wp-json/learnpress/v1/assignments/delete-submit-file/

Parameter:

  • fileId: string
  • id: integer

Get Course Review Content

GET: wp-json/learnpress/v1/review/course/COURSE_ID

Parameter:

  • page: integer
  • per_page: integer

Submit Review

POST: wp-json/learnpress/v1/review/submit

Parameter:

  • id: integer
  • rate: integer
  • title: string
  • content: string

Get Course to Wishlist

GET: wp-json/learnpress/v1/wishlist/course/COURSE_ID

Add/Remove Course to Wishlist

POST: wp-json/learnpress/v1/wishlist/toggle

Parameter

  • id: integer

API for Reset Password Page

POST: wp-json/learnpress/v1/users/reset-password

Parameter:

  • user_login

Conclusion on LearnPress Rest API

Hopefully, you like our REST API List and its various endpoints and use them to create a more robust and feature-rich e-learning platform.

Read More: The Complete List Of LearnPress Shortcodes

Contact US | ThimPress:

Website: https://thimpress.com/

Fanpage: https://www.facebook.com/ThimPress

YouTube: https://www.youtube.com/c/ThimPressDesign

Twitter (X): https://twitter.com/thimpress

TAGS:

Sally Do

Content is King but engagement is Queen, and the lady rules the house!

Related Articles

Home Plugins Themes Cart