Get CourseMemberID API

Get CourseMemberID API

Description:  To fetch the list of course members' details

Request URL:    /api/v4/<orgId>/course/<courseId>/courseMembers.json?filter=3&sort=1

Method: GET

OAuth scope: TrainerCentral.courseapi.READ

Parameters:

  KeyName
  DataType
   SampleID
  si
  int
   0
  sort
  int
   1
  limit
  int 
   20
  searchText
  String
   "John"
  filter
  int
   3

Parameters - description:

start index -  This indicates where the list should start from, whether from 0 or from other position like 5.
sort -  To sort the data.
limit - The number of course members you want to fetch in an instance, and default limit value is 20.

filter - To retrive the data in a specific filter.


Info
Filter:
              TYPE = 3
Sort:
              SORT_BY_COURSE_PROGRESS - 5
              SORT_BY_TIME - 1

Sample request:

https://zylkeracademy.trainercentral.com/api/v4/{org ID}/courses { courseID}/courseMembers.json


Sample response:

  1. "courseMembers": [
        {
          "lastLogin": "1728628131563",
          "country": "INDIA",
          "role": "3",
          "orgId": "TC-ORGID",
          "formattedTotalRevenue": "$104.00",
          "courseMembersId": "{COURSE_MEMBER_ID}",
          "orgMemberId": "{ORG_MEMBER_ID}",
          "imageUrl": "{IMAGE_URL}",
          "course": "{COURSE_ID}",
          "completedLesson": "0",
          "id": "{COURSE_MEMBER_ID}",
          "totalRevenue": "104.00",
          "courseId": "{COURSE_ID}",
          "email": "{EMAIL_ID}",
          "ipAddress": "{IP_ADDRESS}",
          "userId": "{USERID}",
          "enrolledTime": "1700714216252",
          "completionPercentage": "0",
          "name": "{LEARNER_NAME}",
          "time": "1700714266048",
          "status": "50",
          "totalLesson": "3"
        }
      ],
      "meta": {
        "prospectMembersCount": "{{TOTAL_PROSPECT_COUNT_IN_COURSE}}",
        "membersCount": "{TOTAL_LEARNER_COUNT_IN_COURSE}"
      }
    }