Docs home

Get Session

Returns the full settings of one session, as needed to edit it: time, tutor, live settings, batches, notification flags, shareable link and the recurrence it was created with. Put the session's `attendance_id` in the URL. Use it to prefill an "Update Session" call.

GET/class/attendance/details/{attendance_id}
Get Session
curl --request GET \
  --url 'https://<your-api-host>/nuSource/api/v1/class/attendance/details/{attendance_id}' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>'
{
  "code": 200,
  "message": "Success",
  "payload": {
    "attendance": {
      "attendance_id": 48928,
      "class_name": "Sample Post Session Scheudle",
      "class_type": 3,
      "status": 0,
      "taken_by": 1687,
      "is_live": 1,
      "virtual_class_type": 1,
      "zoom_room_waiting": 0,
      "external_class_link": "",
      "is_free_enrolment": 0,
      "class_date": 1773014400,
      "start_time": 30,
      "end_time": 90,
      "teacher_class_date": 1773014400,
      "teacher_start_time": 30,
      "teacher_end_time": 90,
      "gmt_start_time": 1772996400,
      "gmt_end_time": 1773000000,
      "gmt_teacher_start_time": 1772996400,
      "gmt_teacher_end_time": 1773000000,
      "topics_taught": "<p>Topic</p>",
      "pages_taught": "",
      "homework": "",
      "topics_taught_ids": "",
      "total": 211,
      "master_batch_id": 173,
      "master_batch_name": "Master Maths",
      "class_ids": "197,201",
      "master_batch_ids": "173,177",
      "master_batch_names": "Master Maths,Master Chemistry Crash",
      "class_id": 197,
      "send_reminder_when_scheduled": 1,
      "send_reminder_before_session": 1,
      "is_sharable_link_enabled": true,
      "can_join_without_login": true,
      "sharable_link": "https://domain.edmingle.com/edmingleliveclass/join?token=u3tACwoqLoNBtOnj",
      "repeat_type": 0,
      "custom_recurrence": null,
      "total_sessions": 0,
      "feedback_form_id": ""
    }
  }
}

Access: Institute admins and tutors, plus custom roles that can view schedules or mentoring sessions. The session must belong to a class in your organizations, or one you teach or created.

Path parameters
attendance_idintegerrequired
The session.
Query parameters
Fills total_sessions with how many sessions an update would touch: 1 this and all later sessions of the series, 2 the series' sessions between start_date and end_date.
Start of the range for update_type 2, for example 2026-07-01.
end_datestring
End of the range for update_type 2.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Success
payloadobject
Show child attributesHide child attributes
Show child attributesHide child attributes
Example: Sample Post Session Scheudle
0 Normal, 1 Exam, 2 Extra, 3 Batch-level, 4 Event, 5 Mentoring
Example: 3
0 Not signed in, 1 Signed in, 2 Postponed, 3 Cancelled, 4 Late sign-in, 5 Missed sign-in
Example: 0
Tutor ID
Example: 1687
0 Offline, 1 Zoom Meeting, 5 Zoom Webinar, 6 Custom Link
Example: 1
Unix timestamp
Example: 1773014400
Minutes after midnight
Example: 90
Example: 1773014400
Example: 1772996400
Example: 1773000000
Example: 1773000000
Example: <p>Topic</p>
Students
Example: 211
Example: Master Maths
Example: 197,201
Example: Master Maths,Master Chemistry Crash
Example: 197
As sent to "Create Session"

Notes: Fails with code 25001 "Invalid Attendance ID" if the session isn't found or isn't yours. Rate limit: 100 requests per minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI