View all courses API
Description: To fetch the list of all courses in your academy.
Request URL: /api/v4/<orgId>/courses.json?limit=<Number of courses fetched in this instance>&si=<Start index>
(How to get my <orgId>?)
OAuth scope: TrainerCentral.courseapi.READ
- Limit - Number of courses you want to fetch in an instance.
- Start index - This indicates where the list should start from, whether from 0 or from other position like 5.
{
"courses": [
{
"isHiddenCourse": "false",
"includeAllRecurringTalkInMandation": "false",
"description": "<Course description>",
"courseURL": "https://<your domain>/course/<course unique key>",
"isPaidActiveTicketAvailable": "false",
"type": "0",
"orgId": "<orgId>",
"formattedTotalRevenue": "Rs.0",
"isFeaturedCourse": "false",
"enableReview": "true",
"descriptionId": "<descriptionId>",
"subTitle": "Course subtitle",
"excludeLiveLessonsInMandation": "false",
"lastUpdatedTime": "1643268420051",
"links": {
"sessions": "/api/v4/<orgId>/course/<courseId>/sessions.json",
"site": "/api/v4/<orgId>/course/<courseId>/site.json",
"tickets": "/api/v4/<orgId>/course/<courseId>/tickets.json",
"assignments": "/api/v4/<orgId>/course/<courseId>/assignments.json",
"certificates": "/api/v4/<orgId>/course/<courseId>/certificates.json",
"siteSettings": "/api/v4/<orgId>/course/<courseId>/siteSettings.json",
"reviews": "/api/v4/<orgId>/course/<courseId>/reviews.json",
"coupons": "/api/v4/<orgId>/coupons.json",
"paymentPortals": "/api/v4/<orgId>/paymentPortals.json",
"courseMembers": "/api/v4/<orgId>/course/<courseId>/courseMembers.json",
"drips": "/api/v4/<orgId>/course/<courseId>/drips.json",
"sections": "/api/v4/<orgId>/course/<courseId>/sections.json"
},
"id": "<courseId>",
"testCompletionEnabled": "false",
"totalRevenue": "0.0",
"courseId": "<courseId>",
"publishStatus": "1",
"lastUpdatedBy": "<userId>",
"scheduledTime": "0",
"materialCompletionEnabled": "false",
"kind": "0",
"uniqueKey": "<course unique key>",
"totalRating": "0",
"excludeLiveLessonsInCompletion": "false",
"courseName": "<course name>",
"materialCompletionPercentage": "0",
"scheduleType": "0",
"createdBy": "<userId>",
"mandateLessonOrder": "false",
"enrolledCount": "1",
"time": "1642742957817",
"isPrivateCourse": "false"
}
],
"courseCategories": [
{
"moduleCategoryMappingId": "<moduleCategoryMappingId>",
"moduleType": "1",
"course": "<courseId>",
"id": "<moduleCategoryMappingId>",
"moduleId": "<moduleId>",
"category": "<categoryId>",
"categoryId": "<categoryId>"
}
],
"meta": {
"totalCourseCount": "<totalCourseCount>",
"selectedCourseCount": "<selectedFilterCourseCount>"
},
"courseMembers": [
{
"role": "0", ADMIN = 0, SPEAKER = 1, ATTENDEE= 3, PREVIEWER =4
"userId": "<userId>",
"orgId": "<orgId>",
"completionPercentage": "0",
"courseMembersId": "3273311000000323004",
"imageUrl": "/api/v4/<orgId>/materials/image/<imageId>.json",
"name": "course member name",
"course": "<courseId>",
"time": "1642742957821",
"id": "<course member Id>",
"courseId": "<courseId>",
"email": "<userEmail>",
"status": "0"
}
]
}
Related Articles
List of all TrainerCentral APIs
Getting Started Get Oauth token API Course APIs Create chapter API Edit chapter API Create course API Edit course API Create lesson API Edit lesson API Create assignment API Delete lesson/live workshop/assignment API Delete chapter API Delete course ...View all upcoming sessions API
Description: To fetch the list of all upcoming live sessions. The list will only include live workshops, and it will not include live lessons of courses. Request URL: /api/v4/<orgId>/talks.json?filter=<Filter type>&limit=<Total course ...Learner guide - View transaction history
You can view the complete list of all ticket purchases and monetary transactions associated with your account under the Transactions tab. Under this tab, you can check out what courses you've purchased, ticket value, status of the payment, date of ...Delete course API
Description: To delete a course in an academy. Request URL: <domain>/api/v4/<orgId>/courses/<courseId>.json Method: DELETE OAuth Scope: TrainerCentral.courseapi.DELETE Parameters: Not applicable Request Body: Not applicable Sample Request: ...Edit course API
Description: To edit a course in the academy Request URL: <domain>/api/v4/<orgId>/courses/<courseId>.json Method: PUT OAuth Scope: TrainerCentral.courseapi.UPDATE Parameters: Not applicable Request Body: { "course":{ "courseName":"<course ...