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=1&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
   1

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_ALL=1
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}"
      }
    }



    • 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 ...

    • Get Academy Learners API

      Description: To fetch the list of learners enrolled in an academy. Request URL: <domain>/api/v4/<orgId>/portalMembers.json?type=5 (How do I get my OrgID?) Method: GET OAuth scope: TrainerCentral.presenterapi.READ Parameters: type - <Integer> <Value ...

    • Get learner info API

      Description: To fetch learner info from signup forms. Request URL: <domain>/api/v4/<orgId>/fetchuserdetails.json Method: GET OAuth Scope: TrainerCentral.userapi.READ Parameters:  email string Email address of the learner for whom the details are to ...

    • Get academy OrgID API

      When you log in to TrainerCentral, you can see an ID (<orgId>) in the URL which will be a number. Example: https://trainercentral.com/#/portal/<orgID>/sessions/upcoming?sort=1  This <orgID> is used in the request URL of the APIs listed below. If you ...

    • Learner reports API

      Course Report Description: To fetch the course engagement report of a particular learner. Request URL: /api/v4/<orgId>/course/<courseId>/courseMember/<courseMemberId>/courseEngagement.json  (How do I get the courseMemberID?) Method: GET OAuth scope: ...