Docs home

Admin Retrieve Course of Student Enrolled

Lists a learner's course enrollments (bookings) with their payment status, plus their course registrations and special-fee payments. Use it to see what a learner has bought and what they still owe. Pass a parent's user ID to get the bookings of all their linked learners.

GET/institution/user/bookings
Admin Retrieve Course of Student Enrolled
curl --request GET \
  --url 'https://<your-api-host>/nuSource/api/v1/institution/user/bookings?user_id=<user_id>' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>'
{
  "code": 200,
  "message": "Success",
  "bookings": [
    {
      "package_id": 26,
      "institution_id": 7,
      "payment_id": 1227,
      "payment_status": "pending",
      "payment_scheme": 1,
      "discount": 0,
      "amount": 1000,
      "currency_symbol": "₹",
      "position": 1,
      "base_currency_id": 49,
      "currency_id": 49,
      "conversion_rate": 1,
      "adjustment_rate": 0,
      "num_of_decimals": 2,
      "date_of_commencement": "",
      "institution_name": "Main Center",
      "package_name": "Test Series 1",
      "student_name": "vaibhav",
      "student_email": null,
      "student_contact_number": "9794554548",
      "student_bundle_status": 1,
      "date_of_enrolment": "11/06/2018",
      "final_amount": 1000,
      "institution_bundle_id": 26,
      "course_ids": [
        "34",
        "93",
        "94"
      ],
      "fees_template_ids": [
        "7",
        "23",
        "27"
      ],
      "enrollment_id": 1242,
      "selected_subjects": null,
      "promocode_text": null,
      "is_free_enrolment": 0,
      "academic_year": 2,
      "enrollment_expiration_date": 0,
      "enrollment_expired": null
    },
    {
      "package_id": 82,
      "institution_id": 7,
      "payment_id": 1228,
      "payment_status": "pending",
      "payment_scheme": 1,
      "discount": 0,
      "amount": 500,
      "currency_symbol": "₹",
      "position": 1,
      "base_currency_id": 49,
      "currency_id": 49,
      "conversion_rate": 1,
      "adjustment_rate": 0,
      "num_of_decimals": 2,
      "date_of_commencement": "",
      "institution_name": "Main Center",
      "package_name": "Reasoning",
      "student_name": "vaibhav",
      "student_email": null,
      "student_contact_number": "9794554548",
      "student_bundle_status": 1,
      "date_of_enrolment": "11/06/2018",
      "final_amount": 500,
      "institution_bundle_id": 88,
      "course_ids": [
        "217"
      ],
      "fees_template_ids": [
        "7"
      ],
      "enrollment_id": 1243,
      "selected_subjects": null,
      "promocode_text": null,
      "is_free_enrolment": 0,
      "academic_year": 3,
      "enrollment_expiration_date": 0,
      "enrollment_expired": null
    },
    {
      "package_id": 95,
      "institution_id": 1,
      "payment_id": 3924,
      "payment_status": "pending",
      "payment_scheme": 41,
      "discount": 0,
      "amount": 10000,
      "currency_symbol": "$",
      "position": 1,
      "base_currency_id": 1,
      "currency_id": 1,
      "conversion_rate": 1,
      "adjustment_rate": 0,
      "num_of_decimals": 2,
      "date_of_commencement": "",
      "institution_name": "Institution 1",
      "package_name": "Test Package zzz",
      "student_name": "vaibhav",
      "student_email": null,
      "student_contact_number": "9794554548",
      "student_bundle_status": 1,
      "date_of_enrolment": "20/05/2022",
      "final_amount": 10000,
      "institution_bundle_id": 100,
      "course_ids": [
        "23",
        "24",
        "82"
      ],
      "fees_template_ids": [
        "41"
      ],
      "enrollment_id": 4016,
      "selected_subjects": "23,24,82",
      "promocode_text": "",
      "is_free_enrolment": 0,
      "academic_year": 5,
      "enrollment_expiration_date": 0,
      "enrollment_expired": null
    }
  ],
  "registrations": [],
  "special_fees": []
}

Access: Institute admins, plus custom roles that can view learners. Only enrollments in organizations you belong to are returned.

Query parameters
user_idintegerrequired
The learner's user ID (or a parent's user ID).
payment_idinteger
Return only this booking.
Only courses of this course type.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Success
bookingsobject[]
One entry per enrollment, newest first
Show child attributesHide child attributes
Course ID
Example: 26
Example: 7
Booking ID, used by "Retrieve a Student Booking"
Example: 1227
pending or a paid state
Example: pending
Example: 1
Example: 0
Example: 1000
Example: ₹
Symbol before or after the amount
Example: 1
Example: 49
Example: 49
Example: 1
Example: 0
Example: 2
Branch name
Example: Main Center
Example: Test Series 1
Example: vaibhav
Example: 9794554548
DD/MM/YYYY
Example: 11/06/2018
Example: 1000
Example: 1242
0/1
Example: 0
Example: 2
Unix timestamp, 0 if none
Example: 0
Special-fee payments, same fields as bookings where they apply

Notes: Returns empty arrays if the user is neither a learner nor a parent with linked learners. Rate limit: 30 requests per 1 minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI