Search Student
Looks up a learner by mobile number or email and tells you whether they exist. Use it before enrolling someone to check if they already have an account, and optionally whether they are already in a course or batch.
/student/searchcurl --request GET \
--url 'https://<your-api-host>/nuSource/api/v1/student/search?institution_id=<institutionId>&student_email=hemal@edmingle.com&student_mobile_number=9878987898' \
--header 'APIKEY: <your-api-key>' \
--header 'ORGID: <your-org-id>'{
"code": 200,
"message": "Success",
"user_details": [
{
"role": "student",
"student_email": "hemal@edmingle.com"
}
]
}Access: Public, no API key needed. If you send an API key for an institute admin (or an admin or custom role who shares an organization with the learner), the response also includes the learner's ID, name, phone, email and username.
student_email is ignored.ORGID organization.1 matches users of any role, not only learners. Default 0 (learners only).200SuccessShow child attributesHide child attributes
studenthemal@edmingle.comNotes: Returns "No such user." when nothing matches. When you pass bundle_id or batch_id and the learner is already enrolled in the course: if they are in one of the batches you named you get "Already enrolled in this course package."; otherwise you get an error that carries student_name and batch_names (the batches they are already in), so you can ask whether to add them to another batch.