Retrieve a Student
Returns the full profile of one learner in your organization: contact details, personal details, guardian, organizations, enrollment status, and their custom and system profile fields. Use it to sync a learner's record into another system.
GET
/user/detailsRetrieve a Student
curl --request GET \
--url 'https://<your-api-host>/nuSource/api/v1/user/details?user_id=<user_id>' \
--header 'APIKEY: <your-api-key>' \
--header 'ORGID: <your-org-id>'{
"code": 200,
"message": "Success",
"user": {
"user_id": 89748572,
"name": "sake",
"email": "shaik@gmail.com",
"contact_number": "9908607678",
"contact_number_2": null,
"user_username": "sake5352535",
"organization_ids": [
"329"
],
"address": null,
"user_role": 1,
"org_user_status": [
"1"
],
"url": "",
"first_name": "",
"last_name": "",
"emergency_contact": "",
"emergency_person": "",
"gender": "",
"birthday": "",
"registration_numbers": [
"784"
],
"religion": 0,
"occupation": 0,
"qualification": 0,
"u_parent_name": "hsi",
"u_parent_contact": "",
"u_parent_email": "saeunxkth@gmail.com",
"city": "gsi",
"state": "0",
"pincode": null,
"school": "",
"standard": 0,
"ed_background": null,
"aadhaar_number": null,
"landline": null,
"alternate_email": null,
"residential_address": null,
"cf_1": "",
"cf_2": "",
"cf_3": "",
"cf_4": "",
"cf_5": "",
"area": 0,
"source": 1,
"archived_status": [
"0"
],
"timezone": "(UTC+05:30) Asia/Calcutta",
"about": "",
"contact_number_country_id": 103,
"contact_number_2_country_id": 103,
"u_parent_contact_country_id": null,
"contact_number_dial_code": "+91",
"contact_number_2_dial_code": "+91",
"u_parent_contact_country_dial_code": "",
"document_name": [],
"custom_fields": [
{
"field_id": 234163,
"organization_id": 329,
"field_display_name": "Text | online Pre",
"field_help_text": "",
"field_type": 1,
"default_value": "",
"possible_values": "[]",
"field_name": "text_|_online_pre",
"original_form_type": 1,
"field_value": "",
"form_field_mapper_id": 244654,
"form_type": 1,
"system_field_setting": 0,
"section_id": 1,
"show_online": 1,
"is_online_mandatory": 1,
"show_offline": 0,
"is_offline_mandatory": 0,
"is_active": 1,
"display_index": 37
},
{
"field_id": 234162,
"organization_id": 329,
"field_display_name": "Text | Post man",
"field_help_text": "",
"field_type": 1,
"default_value": "",
"possible_values": "[]",
"field_name": "text_|_post_man",
"original_form_type": 1,
"field_value": "",
"form_field_mapper_id": 244653,
"form_type": 1,
"system_field_setting": 0,
"section_id": 1,
"show_online": 1,
"is_online_mandatory": 1,
"show_offline": 0,
"is_offline_mandatory": 0,
"is_active": 1,
"display_index": 48
},
{
"field_id": 217067,
"organization_id": 329,
"field_display_name": "File Upload demo",
"field_help_text": "",
"field_type": 5,
"default_value": "",
"possible_values": "[]",
"field_name": "file_upload_demo",
"original_form_type": 1,
"field_value": "",
"form_field_mapper_id": 227807,
"form_type": 1,
"system_field_setting": 0,
"section_id": 1,
"show_online": 0,
"is_online_mandatory": 0,
"show_offline": 1,
"is_offline_mandatory": 0,
"is_active": 1,
"display_index": 59
},
{
"field_id": 58272,
"organization_id": 329,
"field_display_name": "File Upload",
"field_help_text": "",
"field_type": 5,
"default_value": "",
"possible_values": "[]",
"field_name": "file_upload",
"original_form_type": 1,
"field_value": "",
"form_field_mapper_id": 71291,
"form_type": 1,
"system_field_setting": 0,
"section_id": 1,
"show_online": 0,
"is_online_mandatory": 0,
"show_offline": 0,
"is_offline_mandatory": 0,
"is_active": 1,
"display_index": 63
},
{
"field_id": 58269,
"organization_id": 329,
"field_display_name": "Just Some Num Fields",
"field_help_text": "",
"field_type": 2,
"default_value": "",
"possible_values": "[]",
"field_name": "number_field",
"original_form_type": 1,
"field_value": "",
"form_field_mapper_id": 71288,
"form_type": 1,
"system_field_setting": 0,
"section_id": 1,
"show_online": 0,
"is_online_mandatory": 0,
"show_offline": 0,
"is_offline_mandatory": 0,
"is_active": 1,
"display_index": 68
},
{
"field_id": 195951,
"organization_id": 329,
"field_display_name": "test11",
"field_help_text": "",
"field_type": 1,
"default_value": "",
"possible_values": "[]",
"field_name": "test11",
"original_form_type": 1,
"field_value": "",
"form_field_mapper_id": 207065,
"form_type": 1,
"system_field_setting": 0,
"section_id": 1,
"show_online": 0,
"is_online_mandatory": 0,
"show_offline": 0,
"is_offline_mandatory": 0,
"is_active": 1,
"display_index": 69
},
{
"field_id": 234164,
"organization_id": 329,
"field_display_name": "Text | Online Post",
"field_help_text": "",
"field_type": 1,
"default_value": "",
"possible_values": "[]",
"field_name": "text_|_online_post",
"original_form_type": 1,
"field_value": "",
"form_field_mapper_id": 244655,
"form_type": 1,
"system_field_setting": 0,
"section_id": 1,
"show_online": 0,
"is_online_mandatory": 0,
"show_offline": 0,
"is_offline_mandatory": 0,
"is_active": 1,
"display_index": 91
},
{
"field_id": 214629,
"organization_id": 329,
"field_display_name": "Occupation t",
"field_help_text": "",
"field_type": 1,
"default_value": "",
"possible_values": "[]",
"field_name": "occupation_t",
"original_form_type": 1,
"field_value": "",
"form_field_mapper_id": 225413,
"form_type": 1,
"system_field_setting": 0,
"section_id": 1,
"show_online": 1,
"is_online_mandatory": 1,
"show_offline": 0,
"is_offline_mandatory": 0,
"is_active": 1,
"display_index": 92
},
{
"field_id": 26597,
"organization_id": 329,
"field_display_name": "Mother's Name",
"field_help_text": "",
"field_type": 1,
"default_value": "",
"possible_values": "[]",
"field_name": "mother's_name",
"original_form_type": 1,
"field_value": "",
"form_field_mapper_id": 38990,
"form_type": 1,
"system_field_setting": 0,
"section_id": 1,
"show_online": 1,
"is_online_mandatory": 0,
"show_offline": 0,
"is_offline_mandatory": 0,
"is_active": 1,
"display_index": 99
},
{
"field_id": 58270,
"organization_id": 329,
"field_display_name": "Select field123",
"field_help_text": "",
"field_type": 3,
"default_value": "",
"possible_values": "[{\"name\":\"opt 1\",\"value\":1,\"status\":1},{\"name\":\"opt 2\",\"value\":2,\"status\":1},{\"name\":\"opt va\",\"value\":3,\"status\":1}]",
"field_name": "select_field",
"original_form_type": 1,
"field_value": "",
"form_field_mapper_id": 71289,
"form_type": 1,
"system_field_setting": 0,
"section_id": 1,
"show_online": 0,
"is_online_mandatory": 0,
"show_offline": 0,
"is_offline_mandatory": 0,
"is_active": 1,
"display_index": 102
},
{
"field_id": 330440,
"organization_id": 329,
"field_display_name": "Mobile",
"field_help_text": "Select",
"field_type": 3,
"default_value": "",
"possible_values": "[{\"name\":\"Oneplus\",\"value\":1,\"status\":1},{\"name\":\"Iphone\",\"value\":2,\"status\":1},{\"name\":\"Samsung\",\"value\":3,\"status\":1}]",
"field_name": "mobile",
"original_form_type": 1,
"field_value": "",
"form_field_mapper_id": 340258,
"form_type": 1,
"system_field_setting": 0,
"section_id": 1,
"show_online": 1,
"is_online_mandatory": 0,
"show_offline": 0,
"is_offline_mandatory": 0,
"is_active": 1,
"display_index": 103
},
{
"field_id": 331829,
"organization_id": 329,
"field_display_name": "testing signup",
"field_help_text": "",
"field_type": 3,
"default_value": "",
"possible_values": "[]",
"field_name": "testing_signup",
"original_form_type": 1,
"field_value": "",
"form_field_mapper_id": 341625,
"form_type": 1,
"system_field_setting": 0,
"section_id": 1,
"show_online": 0,
"is_online_mandatory": 0,
"show_offline": 0,
"is_offline_mandatory": 0,
"is_active": 1,
"display_index": 125
},
{
"field_id": 58271,
"organization_id": 329,
"field_display_name": "Date field",
"field_help_text": "",
"field_type": 4,
"default_value": "",
"possible_values": "[]",
"field_name": "date_field",
"original_form_type": 1,
"field_value": "",
"form_field_mapper_id": 71290,
"form_type": 1,
"system_field_setting": 0,
"section_id": 1,
"show_online": 1,
"is_online_mandatory": 2,
"show_offline": 0,
"is_offline_mandatory": 0,
"is_active": 1,
"display_index": 130
},
{
"field_id": 332145,
"organization_id": 329,
"field_display_name": "My City",
"field_help_text": "",
"field_type": 1,
"default_value": "",
"possible_values": "[]",
"field_name": "my_city",
"original_form_type": 1,
"field_value": "",
"form_field_mapper_id": 341936,
"form_type": 1,
"system_field_setting": 0,
"section_id": 1,
"show_online": 1,
"is_online_mandatory": 0,
"show_offline": 1,
"is_offline_mandatory": 0,
"is_active": 1,
"display_index": 136
}
],
"system_fields": [
{
"field_id": 17271,
"field_name": "student_name",
"is_active": 1,
"show_offline": 1,
"is_offline_mandatory": 1
},
{
"field_id": 17272,
"field_name": "date_of_birth",
"is_active": 1,
"show_offline": 1,
"is_offline_mandatory": 0
},
{
"field_id": 17273,
"field_name": "student_email",
"is_active": 1,
"show_offline": 1,
"is_offline_mandatory": 0
},
{
"field_id": 17276,
"field_name": "permanent_address",
"is_active": 1,
"show_offline": 1,
"is_offline_mandatory": 0
},
{
"field_id": 17278,
"field_name": "state",
"is_active": 1,
"show_offline": 1,
"is_offline_mandatory": 0
},
{
"field_id": 17279,
"field_name": "pincode",
"is_active": 1,
"show_offline": 1,
"is_offline_mandatory": 0
},
{
"field_id": 17280,
"field_name": "student_source",
"is_active": 1,
"show_offline": 1,
"is_offline_mandatory": 0
},
{
"field_id": 17282,
"field_name": "standard",
"is_active": 1,
"show_offline": 1,
"is_offline_mandatory": 0
},
{
"field_id": 17289,
"field_name": "area",
"is_active": 1,
"show_offline": 1,
"is_offline_mandatory": 0
},
{
"field_id": 17290,
"field_name": "school_college_name",
"is_active": 1,
"show_offline": 1,
"is_offline_mandatory": 0
},
{
"field_id": 17293,
"field_name": "residential_address",
"is_active": 1,
"show_offline": 1,
"is_offline_mandatory": 0
},
{
"field_id": 275750,
"field_name": "country",
"is_active": 0,
"show_offline": 1,
"is_offline_mandatory": 0
},
{
"field_id": 275751,
"field_name": "cf_1",
"is_active": 0,
"show_offline": 0,
"is_offline_mandatory": 0
},
{
"field_id": 275752,
"field_name": "cf_2",
"is_active": 0,
"show_offline": 0,
"is_offline_mandatory": 0
},
{
"field_id": 275753,
"field_name": "cf_3",
"is_active": 0,
"show_offline": 0,
"is_offline_mandatory": 0
},
{
"field_id": 275754,
"field_name": "cf_4",
"is_active": 0,
"show_offline": 0,
"is_offline_mandatory": 0
},
{
"field_id": 275755,
"field_name": "cf_5",
"is_active": 0,
"show_offline": 0,
"is_offline_mandatory": 0
},
{
"field_id": 275756,
"field_name": "source",
"is_active": 0,
"show_offline": 1,
"is_offline_mandatory": 0
},
{
"field_id": 17291,
"field_name": "alternate_email",
"is_active": 1,
"show_offline": 1,
"is_offline_mandatory": 0
},
{
"field_id": 17292,
"field_name": "landline_no",
"is_active": 1,
"show_offline": 1,
"is_offline_mandatory": 0
},
{
"field_id": 17295,
"field_name": "registration_number",
"is_active": 1,
"show_offline": 1,
"is_offline_mandatory": 0
},
{
"field_id": 17297,
"field_name": "aadhaar_number",
"is_active": 1,
"show_offline": 1,
"is_offline_mandatory": 0
},
{
"field_id": 17296,
"field_name": "qualification",
"is_active": 1,
"show_offline": 0,
"is_offline_mandatory": 0
},
{
"field_id": 17294,
"field_name": "educational_background",
"is_active": 1,
"show_offline": 0,
"is_offline_mandatory": 0
},
{
"field_id": 17298,
"field_name": "upload_documents",
"is_active": 1,
"show_offline": 0,
"is_offline_mandatory": 0
},
{
"field_id": 17281,
"field_name": "religion",
"is_active": 1,
"show_offline": 1,
"is_offline_mandatory": 0
},
{
"field_id": 17270,
"field_name": "student_mobile_number",
"is_active": 1,
"show_offline": 0,
"is_offline_mandatory": 0
},
{
"field_id": 33105,
"field_name": "timezone",
"is_active": 0,
"show_offline": 1,
"is_offline_mandatory": 0
},
{
"field_id": 17274,
"field_name": "gender",
"is_active": 1,
"show_offline": 1,
"is_offline_mandatory": 0
},
{
"field_id": 275749,
"field_name": "username",
"is_active": 1,
"show_offline": 0,
"is_offline_mandatory": 0
},
{
"field_id": 17283,
"field_name": "occupation",
"is_active": 1,
"show_offline": 0,
"is_offline_mandatory": 0
},
{
"field_id": 17277,
"field_name": "city",
"is_active": 1,
"show_offline": 0,
"is_offline_mandatory": 0
},
{
"field_id": 17286,
"field_name": "parent_name",
"is_active": 1,
"show_offline": 0,
"is_offline_mandatory": 0
},
{
"field_id": 17287,
"field_name": "parent_contact_number",
"is_active": 1,
"show_offline": 1,
"is_offline_mandatory": 1
},
{
"field_id": 17275,
"field_name": "alternate_contact",
"is_active": 1,
"show_offline": 0,
"is_offline_mandatory": 0
},
{
"field_id": 17288,
"field_name": "parent_email",
"is_active": 1,
"show_offline": 0,
"is_offline_mandatory": 0
}
]
}
}Access: Institute admins, plus custom roles that can view learners or instructors.
Query parameters
ID of the learner.
organization_idinteger
Organization whose custom profile fields to return. Must be one of the learner's organizations; otherwise their first organization is used.
Response
codeinteger
Example:
200messagestring
Example:
Successuserobject
Show child attributesHide child attributes
user.user_idinteger
Example:
89748572user.namestring
Example:
sakeuser.emailstring
Example:
shaik@gmail.comuser.contact_numberstring
Example:
9908607678With
contact_number_country_id, contact_number_2_country_id and the matching *_dial_codeuser.user_usernamestring
Example:
sake5352535user.organization_idsstring[]
The organizations you share with this user
user.addressnull
user.org_user_statusstring[]
One value per organization; for learners
1 Registered, 2 Admitted, 3 Completed, 4 On leave; for staff 1 accepted, 0 invite pendinguser.urlstring
Profile picture
user.first_namestring
user.last_namestring
user.emergency_contactstring
user.emergency_personstring
user.genderstring
user.birthdaystring
user.registration_numbersstring[]
user.religioninteger
Example:
0user.occupationinteger
Example:
0user.qualificationinteger
Example:
0user.u_parent_namestring
Example:
hsiuser.u_parent_contactstring
user.u_parent_emailstring
Example:
saeunxkth@gmail.comuser.citystring
Example:
gsiuser.statestring
Example:
0user.pincodenull
user.schoolstring
user.standardinteger
Example:
0user.landlinenull
user.cf_1string
user.cf_2string
user.cf_3string
user.cf_4string
user.cf_5string
user.areainteger
Example:
0user.sourceinteger
Example:
1user.archived_statusstring[]
One
0/1 per organizationuser.timezonestring
Example:
(UTC+05:30) Asia/Calcuttauser.aboutstring
Example:
103Example:
103Example:
+91Example:
+91user.document_namearray
Uploaded documents with download links
user.custom_fieldsobject[]
Each custom form field with its
field_id, field_display_name, field_type and the user's field_value; file fields come back as download linksShow child attributesHide child attributes
user.custom_fields.field_idinteger
Example:
234163Example:
329Example:
Text | online PreExample:
1Example:
[]Example:
text_|_online_preExample:
1Example:
244654user.custom_fields.form_typeinteger
Example:
1Example:
0Example:
1Example:
1Example:
1Example:
0Example:
0user.custom_fields.is_activeinteger
Example:
1Example:
37user.system_fieldsobject[]
Which built-in profile fields the organization has switched on
Show child attributesHide child attributes
user.system_fields.field_idinteger
Example:
17271Example:
student_nameuser.system_fields.is_activeinteger
Example:
1Example:
1Example:
1Notes: Only users who belong to one of your organizations can be read; anyone else returns "User not in institution.". Numbers inside the lists (organization_ids, org_user_status, registration_numbers, archived_status) come back as strings. Rate limit: 30 requests per minute; going over locks you out for 30 minutes.