Rest API

Tutor LMS supports full WordPress REST API and multiple endpoints that you can read to use Tutor LMS resources as HTTP requests in JSON format.

Note: Currently Tutor LMS REST API v1 only provides the read-only capability. Authentication is required for the request to work.

Setting Up Authentication for Tutor LMS Rest API

Step 1: From your Tutor LMS WordPress dashboard, navigate to Settings > Tools > Rest API.

Step 2: Click on Add New and then Generate button to generate a new API key and secret key pair.

Make sure to keep this page open, as you will need these keys in the next steps.

Step 3: Set Authorization. If you’re using Postman, open the Authorization tab for your desired request. Choose Basic Auth as the Type.

Step 4: Copy the generated API key from the Tutor LMS Rest API page and paste it into the Username field of the Authorization tab in Postman. Similarly, copy the secret key and paste it into the Password field.

Step 5: Now, you are ready to send the GET request to retrieve the desired data from the Tutor LMS Rest API. Make sure the request is properly configured with the correct endpoint and any required parameters.

Step 6: Click on the Send button to initiate the request. If the authentication is successful, you will receive the response containing the requested data.

That’s it! You have successfully set up authentication for Tutor LMS Rest API. You can now explore different endpoints and retrieve data securely.

Current Available Endpoints:

Below is a list of read APIs that are ready for serving both native and third-party applications.

Note: In the following URLs “yourwebsiteaddress” refers to your live LMS website address.

Get Course

URL: http://yourwebsiteaddress/wp-json/tutor/v1/courses?order=desc&orderby=ID&paged=1
Type: get
Parameters: optional
Pagination: true

Get Course Detail By Course ID

URL: http://yourwebsiteaddress/wp-json/tutor/v1/course-detail/(course-id)
Type: get
Parameter: required(number)

Get Course Topics By Course ID

URL: http://yourwebsiteaddress/wp-json/tutor/v1/course-topic/(course-id)
Type: get
Parameter: required (number)

Get Lesson By Topic ID

URL: http://yourwebsiteaddress/wp-json/tutor/v1/lesson/(topic-id)
Type: get
Parameter: required(number)

Course Announcements By Course ID

URL: http://yourwebsiteaddress/wp-json/tutor/v1/course-annoucement/(course-id)
Type: get
Parameter: required(number)

Quiz By Topic ID

URL: http://yourwebsiteaddress/wp-json/tutor/v1/quiz/(topic-id)
Type: get
Parameter: required(number)

Quiz Questions By Quiz ID

URL: http://yourwebsiteaddress/wp-json/tutor/v1/quiz-question-answer/(quiz-id)
Type: get
Parameter: required(number)

Author Info By Author ID

URL: http://yourwebsiteaddress/wp-json/tutor/v1/author-information/(author-id)
Type: get
Parameter: required(number)

Course Ratings By Course ID

URL: http://yourwebsiteaddress/wp-json/tutor/v1/course-rating/(course-id)
Type: get
Parameter: required(number)

Course By Terms (Category/Tags)

URL: http://yourwebsiteaddress/wp-json/tutor/v1/course-by-terms/(category-id)
Type: post
"categories":["web"], //array optional
"tags": ["php"] //array optional

Course Sorting By Price Asc/Desc

URL: http://yourwebsiteaddress/wp-json/tutor/v1/course-sorting-by-price?order=desc&page=1
Type: get
Parameter: order (required,string), page(optional,number)

Was this helpful?