GET /Api/v3/Class/actions/getdetailed

Retrieves all the details of a specified class, including full student data.

Request Path

GET /api/v3/class/actions/getdetailed?classId={Class Id}

Request Payload



classId The id of the class. To retrieve class ids, use GET /api/v3/class
Example: COMcB7gdfab2DFm0WqklnX6Q2
So the call will be: /api/v3/class/actions/getdetailed?classId=COMcB7gdfab2DFm0WqklnX6Q2

Response Example

  "class": {
    "policyId": "PO_1spRc94a28XpE3WNcnR3Q2",
    "policyName": "Demo - 1D/1D/60m",
    "policyExternalId": "Demo for classes",
    "blueprintId": "BP1lD34Fcpog6a0N01tXbQ2",
    "blueprintName": "1 Day class",
    "cloudName": "CloudShare",
    "regionId": "REKolD1-ab84YIxODeMGob9A2",
    "regionName": "US East (Miami)",
    "timeZoneId": "UTC",
    "projectId": "PRqLKdtgh14bxPh8acLtQE5g2",
    "projectName": "CloudShare Training",
    "teamId": "TMwcpLjdtRt487vBnsqDekOw2",
    "teamName": "CloudShare",
    "creatorUserId": "USsa-F4fcoyuq4vBjS_mz4dw2",   
    "instructorVupId": "VPoks4Eovtal_qfH22sruXOw2",
    "instructorName": "Jane Doe",
    "defaultDurationInMinutes": 1440,
    "studentPassphrase": "Felicity the Mindful Catfish",
    "useCustomInvitationEmail": false,
    "showCourseAddressField": true,
    "address": null,
    "customInvitationEmailSubject": null,
    "customInvitationEmailBody": null,
    "permitAccessToNonRegisteredStudent": true,
    "maxStudents": 10,    
    "customFieldsValues": [
        "id": "TFiYf28Ddfds4_pHqv2YTA2",
        "order": 1,
        "name": "SalesforceId",
        "type": 0,
        "isRequired": false,
        "regex": "",
        "defaultValue": null,
        "value": "SF123456"
    "enableSteps": false,
    "steps": [],
    "studentsCanSwitchStep": false,
    "instructorEmail": "",
    "instructorUserId": "USCMQdAQBBviQwp0_cGjKaTw2",
    "timeZoneName": "Universal Coordinated Time",
    "startDate": "02/08/2018 1:00 PM",
    "startDateUtcOffsetMinutes": 120,
    "endDate": "12/31/2020 1:00 PM",
    "endDateUtcOffsetMinutes": 120,
    "status": "in session",
    "name": "Test class",
    "shortId": "0wda13cd",
    "studentLoginUrl": "",
    "id": "COCjECsFpTfk2_s2xv-sfw2"
  "students": [
      "firstName": "Test",
      "lastName": "Student",
      "email": "",
      "company": "My Company",
      "jobLevel": "Executive",
      "address1": "My Address 1",
      "address2": "My Address 2",
      "city": "My City",
      "state": "California",
      "zipCode": "998877",
      "country": "United States",
      "phone": "123456",
      "regCode": "My Reg Code",
      "id": "SD5nsGYPHO0t1HeWIY7lJtPQ2"