Docs home

List All Students

Returns the learners in your organization, one page at a time. Use it to copy your learner list into another system, or to find learners by name, email, phone, registration number, course, batch or custom field.

GET/organization/students
List All Students
curl --request GET \
  --url 'https://<your-api-host>/nuSource/api/v1/organization/students?organization_id=<organizationId>&is_archived=0&page=1&per_page=<per_page>' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>'
{
  "students": [
    {
      "user_id": "2",
      "name": "surya ji",
      "email": "surya@gmail.com",
      "role": "1",
      "status": "2",
      "registration_number": "2",
      "user_username": "surya",
      "contact_number": "9437855924",
      "contact_number_2": "7003679760",
      "organization_ids": [
        "2"
      ],
      "parent_name": "Dipak Banka2",
      "parent_contact_number": null,
      "parent_email": null,
      "is_archived": "0",
      "contact_number_country_id": null,
      "contact_number_2_country_id": null,
      "parent_contact_number_country_id": null,
      "contact_number_dial_code": "",
      "contact_number_2_dial_code": "",
      "parent_contact_number_dial_code": ""
    },
    {
      "user_id": "17",
      "name": "Gaurav Doshi",
      "email": "v1aibhav.sharma96@gmail.com",
      "role": "1",
      "status": "2",
      "registration_number": "3",
      "user_username": "gaurav1",
      "contact_number": "9265075346",
      "contact_number_2": null,
      "organization_ids": [
        "2"
      ],
      "parent_name": null,
      "parent_contact_number": null,
      "parent_email": null,
      "is_archived": "0",
      "contact_number_country_id": null,
      "contact_number_2_country_id": null,
      "parent_contact_number_country_id": null,
      "contact_number_dial_code": "",
      "contact_number_2_dial_code": "",
      "parent_contact_number_dial_code": ""
    },
    {
      "user_id": "25",
      "name": "Gaurav Doshi",
      "email": null,
      "role": "1",
      "status": "2",
      "registration_number": "4",
      "user_username": "gaurav",
      "contact_number": "9354164687",
      "contact_number_2": null,
      "organization_ids": [
        "2"
      ],
      "parent_name": "Dipak Banka2",
      "parent_contact_number": null,
      "parent_email": null,
      "is_archived": "0",
      "contact_number_country_id": null,
      "contact_number_2_country_id": null,
      "parent_contact_number_country_id": null,
      "contact_number_dial_code": "",
      "contact_number_2_dial_code": "",
      "parent_contact_number_dial_code": ""
    },
    {
      "user_id": "46",
      "name": "Demo Student 1",
      "email": "buhahemal101@gmail.com",
      "role": "1",
      "status": "2",
      "registration_number": "705",
      "user_username": "salksfhiairdfgv",
      "contact_number": "8888888888",
      "contact_number_2": null,
      "organization_ids": [
        "2"
      ],
      "parent_name": null,
      "parent_contact_number": null,
      "parent_email": null,
      "is_archived": "0",
      "contact_number_country_id": null,
      "contact_number_2_country_id": null,
      "parent_contact_number_country_id": null,
      "contact_number_dial_code": "",
      "contact_number_2_dial_code": "",
      "parent_contact_number_dial_code": ""
    },
    {
      "user_id": "47",
      "name": "DemoStudent.com",
      "email": "hemal.buha1@adypu.edu.in",
      "role": "1",
      "status": "2",
      "registration_number": "706",
      "user_username": "s_demo2470",
      "contact_number": "7359943259",
      "contact_number_2": null,
      "organization_ids": [
        "2"
      ],
      "parent_name": null,
      "parent_contact_number": null,
      "parent_email": null,
      "is_archived": "0",
      "contact_number_country_id": null,
      "contact_number_2_country_id": null,
      "parent_contact_number_country_id": null,
      "contact_number_dial_code": "",
      "contact_number_2_dial_code": "",
      "parent_contact_number_dial_code": ""
    },
    {
      "user_id": "48",
      "name": "Demo Student 3",
      "email": "s+demo3@edmingle.com",
      "role": "1",
      "status": "2",
      "registration_number": "707",
      "user_username": "s_demo3906",
      "contact_number": null,
      "contact_number_2": null,
      "organization_ids": [
        "2"
      ],
      "parent_name": null,
      "parent_contact_number": null,
      "parent_email": null,
      "is_archived": "0",
      "contact_number_country_id": null,
      "contact_number_2_country_id": null,
      "parent_contact_number_country_id": null,
      "contact_number_dial_code": "",
      "contact_number_2_dial_code": "",
      "parent_contact_number_dial_code": ""
    },
    {
      "user_id": "49",
      "name": "Demo Student ",
      "email": "abhiss@edmingle.com",
      "role": "1",
      "status": "2",
      "registration_number": "708",
      "user_username": "s_demo4152",
      "contact_number": "8660740295",
      "contact_number_2": null,
      "organization_ids": [
        "2"
      ],
      "parent_name": "Abhi",
      "parent_contact_number": "9663098903",
      "parent_email": null,
      "is_archived": "0",
      "contact_number_country_id": null,
      "contact_number_2_country_id": null,
      "parent_contact_number_country_id": "9663098903",
      "contact_number_dial_code": "",
      "contact_number_2_dial_code": "",
      "parent_contact_number_dial_code": ""
    },
    {
      "user_id": "50",
      "name": "Demo Student 5",
      "email": "s+demo5@edmingle.com",
      "role": "1",
      "status": "2",
      "registration_number": "709",
      "user_username": "s_demo5936",
      "contact_number": null,
      "contact_number_2": null,
      "organization_ids": [
        "2"
      ],
      "parent_name": null,
      "parent_contact_number": null,
      "parent_email": null,
      "is_archived": "0",
      "contact_number_country_id": null,
      "contact_number_2_country_id": null,
      "parent_contact_number_country_id": null,
      "contact_number_dial_code": "",
      "contact_number_2_dial_code": "",
      "parent_contact_number_dial_code": ""
    },
    {
      "user_id": "51",
      "name": "Demo Student 6",
      "email": "s+demo6@edmingle.com",
      "role": "1",
      "status": "2",
      "registration_number": "710",
      "user_username": "s_demo6419",
      "contact_number": null,
      "contact_number_2": null,
      "organization_ids": [
        "2"
      ],
      "parent_name": null,
      "parent_contact_number": null,
      "parent_email": null,
      "is_archived": "0",
      "contact_number_country_id": null,
      "contact_number_2_country_id": null,
      "parent_contact_number_country_id": null,
      "contact_number_dial_code": "",
      "contact_number_2_dial_code": "",
      "parent_contact_number_dial_code": ""
    },
    {
      "user_id": "52",
      "name": "Demo Student 7",
      "email": "s+demo7@edmingle.com",
      "role": "1",
      "status": "2",
      "registration_number": "711",
      "user_username": "s_demo7213",
      "contact_number": null,
      "contact_number_2": null,
      "organization_ids": [
        "2"
      ],
      "parent_name": null,
      "parent_contact_number": null,
      "parent_email": null,
      "is_archived": "0",
      "contact_number_country_id": null,
      "contact_number_2_country_id": null,
      "parent_contact_number_country_id": null,
      "contact_number_dial_code": "",
      "contact_number_2_dial_code": "",
      "parent_contact_number_dial_code": ""
    }
  ],
  "code": 200,
  "message": "Success",
  "page_context": {
    "page": 1,
    "per_page": 10,
    "has_more_page": true,
    "total_rows": "1190"
  }
}

Access: Institute admins and tutors, plus custom roles that can view the learner list or manage marketing campaigns.

Query parameters
pageinteger
Page number, starting at 1. Default 1.
per_pageinteger
Results per page. Default 50.
Organization to list. Defaults to the organization in your ORGID header. If you aren't a member of the one you pass, learners from all your organizations are returned.
statusinteger
Enrollment status: 1 Registered, 2 Admitted, 3 Completed, 4 On leave. Leave it out to get all.
1 returns only archived learners, 0 only active ones. Leave it out to get both.
signup_start_dateUnix timestamp
Only learners who signed up on or after this time.
signup_end_dateUnix timestamp
Only learners who signed up on or before this time. Defaults to one day after signup_start_date.
Comma-separated course IDs within the organization (institution_bundle_id from "Institution Course Bundles"). Only learners actively enrolled in one of them.
class_idstring
Comma-separated batch IDs. Only learners currently in one of these batches (not on leave, completed or cancelled). Combine with institution_bundle_id to require both.
Comma-separated course IDs. Only learners who are not actively enrolled in any of them.
Only learners enrolled in that academic year.
startUnix timestamp
Only learners whose enrollment date (or registration time, with status=1) is on or after this time.
endUnix timestamp
Same as start, on or before this time.
categorystring or array
Category (stream) IDs the learner picked at signup, comma-separated or as an array.
custom_fieldsJSON string
Filter by custom field values: a list of objects with field_id, field_type and value. Text and number fields match part of the value; dropdowns match any listed value; date fields take a date range.
1 only learners with AI companion access, 2 only learners without it.
1 adds companion_status_enabled (1/0) to each learner.
A oldest first (default) or D newest first, by signup date. Do not send sort_by.
Response200application/json
studentsobject[]
Show child attributesHide child attributes
Example: 2
Example: surya ji
Example: surya@gmail.com
Example: 1
Same codes as the status parameter
Example: 2
Example: surya
Example: 9437855924
With contact_number_country_id, contact_number_2_country_id and dial codes
Example: 7003679760
Example: Dipak Banka2
0/1
Example: 0
codeinteger
Example: 200
messagestring
Example: Success
Show child attributesHide child attributes
Example: 1
Example: 10
Example: true
Example: 1190

Notes: Numbers are returned as strings ("user_id": "2"). Contact details (emails, phone numbers, guardian contacts) come back empty if your institute restricts confidential fields for your role. When you filter by academic_year, start, end or category without a course or batch, the list combines enrolled and registered learners and sort_order is not applied. Rate limit: 30 requests per minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI