Get academy OrgID API

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 have customized the URL for your organization profile, then the customized name will be visible in the URL instead of the orgID. Both the URL and orgID of all your portals will be returned as response in the View organization portal API call.

View organization portals

The orgId with the "true" value in the "isDefault" parameter is the currently active organization portal ID.

Description: To fetch the list of all the organization portals of a user. 

Request URL: /api/v4/org/portals.json

Method: GET

OAuth scope: TrainerCentral.portalapi.READ

Sample response

  1. {
  2.   "portals": [
  3.     {
  4.       "planName": <planName>,
  5.       "isTrial": "false",
  6.       "orgLogoUrl": <orgLogoUrl>,
  7.       "url": <url>,
  8.       "referrer": "1",
  9.       "isDefault": "false",
  10.       "portalName": <portalName>,
  11.       "currentUserRole": "0",
  12.       "createdBy": <createdBy>,
  13.       "createdTime": "1502194325666",
  14.       "id": <orgId>,
  15.       "isLogoExists": "false",
  16.       "zsoid": <orgId>

    • Related Articles

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

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

    • Invite learner to academy API

      Description: To invite a learner to your academy. Request URL: /api/v4/<orgId>/addCourseAttendee.json (How to get my <orgId>?) Method: POST OAuth Scope: TrainerCentral.userapi.CREATE Request Parameters: { "courseAttendee": { "email": <Learner's ...

    • 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>?) Method: GET OAuth scope: ...

    • Create chapter API

      Description: To create a chapter under a course in academy Request URL: /api/v4/<orgId>/sections.json (How do I get my orgId?) Method: POST OAuth scope: TrainerCentral.sectionapi.CREATE Parameters: { "section":{ "courseId": "<courseId>", "name": ...