Get Academy Learners API

Get Academy Learners API

Description: To fetch the list of learners enrolled in the academy.

Request URL: <domain>/api/v4/<orgId>/portalMembers.json?limit=10&si=0&type=5 (How do I get my OrgID?)
 
Method: GET
 
OAuth scope: TrainerCentral.presenterapi.READ
 
Parameters:

KeyNameDataTypeSampleID
limit
 int
10
type
int
5
si
int0


Parameters description:


si (start index) - This indicates where the list should start, whether at 0 or any other position.
type=5 - This indicates that the URL will fetch only the learners.
limit - The number of learners you want to fetch in a single instance, and the default limit value is 20.





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

    • Add new learners to your academy

      To add new learners to the academy, a user with Super Admin or Admin privileges can follow the steps below: Navigate to the Users tab in the left pane. Select the Learners tab. Click the Add Learners link at the top-right corner of the page. Add ...

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

    • Add Learners to Your Group

      In TrainerCentral, once you create a group, you can add learners to it. The learners can be from your organization or external individuals. Let's look at the steps to add learners. Click the Add Learners button. The Add learners window will be ...

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