Docs home

Classlist by Date

Lists class sessions in a day, week or month across your organizations, with sign-in status and attendance counts. Use it to build a staff timetable or sync scheduled sessions.

GET/classes/period
Classlist by Date
curl --request GET \
  --url 'https://<your-api-host>/nuSource/api/v1/classes/period?org_id=<organizationId>&date=01-06-2023' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>' \
  --header 'authority: prashant-api.edmingle.com' \
  --header 'accept: application/json, text/javascript, */*; q=0.01' \
  --header 'accept-language: en-US,en;q=0.9' \
  --header 'cache-control: no-cache' \
  --header 'origin: https://demoacademy.edmingle.com' \
  --header 'pragma: no-cache' \
  --header 'referer: https://demoacademy.edmingle.com/' \
  --header 'sec-fetch-dest: empty' \
  --header 'sec-fetch-mode: cors' \
  --header 'sec-fetch-site: same-site'
{
  "code": 200,
  "message": "Success",
  "payload": {
    "classes": [
      [
        5112562,
        4060219,
        "TutorHour",
        1685557800,
        1005,
        1070,
        0,
        -1,
        3982957,
        "Loki",
        "Aashrayz",
        116604,
        2,
        0,
        [
          0,
          0,
          0
        ],
        [],
        2,
        0,
        "",
        "",
        "",
        "",
        0,
        3982957,
        "TutorHour",
        1685557800,
        1005,
        1070,
        0,
        0,
        0,
        50048,
        "AashrayBatch",
        0,
        null,
        0,
        null,
        []
      ],
      [
        4594068,
        3982957,
        "Loki",
        1685557800,
        1275,
        1335,
        0,
        -1,
        3846680,
        "Edmingle Admin",
        "MATHEMATICS 1st YEAR",
        77535,
        136,
        0,
        [
          1,
          1,
          0
        ],
        [],
        136,
        0,
        "",
        "",
        "",
        "",
        0,
        3846680,
        "Loki",
        1685557800,
        1275,
        1335,
        0,
        1,
        0,
        37463,
        "PUC 1st Year",
        1,
        null,
        1,
        null,
        []
      ]
    ]
  }
}

Access: Institute admins, tutors, plus custom roles that can view schedules. Tutors and custom roles without "all batches" access only get sessions of classes they teach or manage. Learners and parents can call it but only get their mentoring sessions.

Query parameters
periodinteger
0 one day (default), 1 the week, 2 the month containing date.
datestring
A day in the period, e.g. 25-12-2024. Default: today in your time zone.
startUnix timestamp
Overrides the period start.
endUnix timestamp
Overrides the period end.
extrainteger
1 ignores the dates and returns sessions of all time.
org_idinteger
One organization. You must belong to it ("Not part of an organization." otherwise). Default: all your organizations.
class_idinteger
Only sessions of this class.
Only sessions of this batch's classes.
tutor_idsstring
Comma-separated user IDs. Only sessions taken by these tutors.
Only mentoring sessions of this service.
1 returns each session as a JSON object. Default: positional arrays.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Success
payloadobject
Show child attributesHide child attributes
payload.classesinteger[][]

Notes: Session status: 0 Not signed in, 1 Signed in, 2 Postponed, 3 Cancelled, 4 Late sign-in, 5 Missed sign-in. class_type: 0 Normal, 1 Exam, 2 Extra, 3 Merged (one session for several classes), 4 Event, 5 Mentoring. virtual_class_type: 0 offline, 1 Zoom Meeting, 2 BotSite, 3 GoTo, 4 GoTo Meeting, 5 Zoom Webinar, 6 Custom link, 7 Super Live, 8 MS Teams. Rate limit: 120 requests per 1 minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI