Get Tutor Details
Returns the full profile of one tutor (or other staff member) in your organization, using the same endpoint as "Retrieve a Student". Use it to read a tutor's contact details, organizations, role and tutor profile fields.
GET
/user/detailsGet Tutor Details
curl --request GET \
--url 'https://<your-api-host>/nuSource/api/v1/user/details?user_id=<TutorId>&organization_id=<organizationId>' \
--header 'APIKEY: <your-api-key>' \
--header 'ORGID: <your-org-id>'{
"code": 200,
"message": "Success",
"user": {
"user_id": 3846680,
"name": "Edmingle Admin",
"email": "prashant@edmingle.com",
"contact_number": "9838398390",
"contact_number_2": null,
"user_username": "demoadmin",
"organization_ids": [
"213",
"214",
"215",
"216",
"241",
"212",
"274",
"326",
"447",
"1176",
"1672",
"1834",
"2020",
"2149",
"2150",
"2164",
"3673",
"3882",
"4219",
"4570",
"4873"
],
"address": null,
"user_role": 2,
"org_user_status": [
"1",
"1",
"1",
"1",
"1",
"1",
"1",
"1",
"1",
"1",
"1",
"1",
"1",
"1",
"1",
"1",
"1",
"1",
"1",
"1",
"1"
],
"url": "https://dme2wmiz2suov.cloudfront.net/User(3846680)/1579125-smart-city-building-technology-real-estate-business-businessman-holding-digital-tablet-buildings-hologram-application-147342778.jpg",
"first_name": "",
"last_name": "",
"emergency_contact": "",
"emergency_person": "",
"gender": "1",
"birthday": "771186600",
"registration_numbers": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"religion": 48,
"occupation": 65,
"qualification": 0,
"u_parent_name": "",
"u_parent_contact": "",
"u_parent_email": "",
"city": "bangalore",
"state": "24",
"pincode": "560037",
"school": "",
"standard": "0",
"ed_background": "[{\"qualification\":\"\",\"yop\":\"\",\"institution\":\"\"}]",
"aadhaar_number": null,
"landline": null,
"alternate_email": null,
"residential_address": null,
"cf_1": "",
"cf_2": "",
"cf_3": "",
"cf_4": "",
"cf_5": "",
"area": null,
"source": 1,
"archived_status": [
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0"
],
"timezone": "(UTC+05:30) Asia/Calcutta",
"about": "<p>Admin account for Instructor's Profile</p>\n",
"contact_number_country_id": 103,
"contact_number_2_country_id": null,
"u_parent_contact_country_id": null,
"contact_number_dial_code": "+91",
"contact_number_2_dial_code": "",
"u_parent_contact_country_dial_code": "",
"document_name": [],
"custom_fields": [
{
"field_id": 243274,
"organization_id": 212,
"field_display_name": "Languages Known",
"field_help_text": "Enter the languages known",
"field_type": 3,
"default_value": "",
"possible_values": "[{\"name\":\"English\",\"value\":1,\"status\":1},{\"name\":\"Hindi\",\"value\":2,\"status\":1},{\"name\":\"Malayalam\",\"value\":3,\"status\":1},{\"name\":\"Bengali\",\"value\":4,\"status\":1},{\"name\":\"Urdu\",\"value\":5,\"status\":1},{\"name\":\"Konkani\",\"value\":6,\"status\":1},{\"name\":\"Tulu\",\"value\":7,\"status\":1},{\"name\":\"Gujarathi\",\"value\":8,\"status\":1},{\"name\":\"Marwadi\",\"value\":9,\"status\":1},{\"name\":\"Telugu\",\"value\":10,\"status\":1},{\"name\":\"Tamil\",\"value\":11,\"status\":1},{\"name\":\"Urdu\",\"value\":12,\"status\":1},{\"name\":\"Sanskrith\",\"value\":13,\"status\":1},{\"name\":\"Chinese\",\"value\":14,\"status\":1}]",
"field_name": "kannada",
"original_form_type": 3,
"field_value": "1",
"form_field_mapper_id": 253660,
"form_type": 3,
"system_field_setting": 0,
"section_id": 1,
"show_online": 0,
"is_online_mandatory": 0,
"show_offline": 1,
"is_offline_mandatory": 1,
"is_active": 1,
"display_index": 4
},
{
"field_id": 196623,
"organization_id": 212,
"field_display_name": "Nick Name",
"field_help_text": "",
"field_type": 1,
"default_value": "",
"possible_values": "[]",
"field_name": "language",
"original_form_type": 3,
"field_value": "English",
"form_field_mapper_id": 207729,
"form_type": 3,
"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": 6
},
{
"field_id": 315094,
"organization_id": 212,
"field_display_name": "test",
"field_help_text": "",
"field_type": 1,
"default_value": "",
"possible_values": "[]",
"field_name": "test",
"original_form_type": 3,
"field_value": "",
"form_field_mapper_id": 324902,
"form_type": 3,
"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": 7
},
{
"field_id": 315158,
"organization_id": 212,
"field_display_name": "Parent Nameasdf",
"field_help_text": "",
"field_type": 1,
"default_value": "",
"possible_values": "[]",
"field_name": "parent_nameasdf",
"original_form_type": 3,
"field_value": "",
"form_field_mapper_id": 324965,
"form_type": 3,
"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": 11
}
],
"system_fields": []
}
}Access: Institute admins, plus custom roles that can view learners or instructors.
Query parameters
ID of the tutor.
organization_idinteger
Organization whose custom profile fields to return. Must be one of the tutor's organizations; otherwise their first organization is used.
Response
codeinteger
Example:
200messagestring
Example:
Successuserobject
Show child attributesHide child attributes
user.user_idinteger
Example:
3846680user.namestring
Example:
Edmingle Adminuser.emailstring
Example:
prashant@edmingle.comuser.contact_numberstring
Example:
9838398390With
contact_number_country_id, contact_number_2_country_id and the matching *_dial_codeuser.user_usernamestring
Example:
demoadminuser.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
Example:
1user.birthdaystring
Example:
771186600user.registration_numbersstring[]
user.religioninteger
Example:
48user.occupationinteger
Example:
65user.qualificationinteger
Example:
0user.u_parent_namestring
user.u_parent_contactstring
user.u_parent_emailstring
user.citystring
Example:
bangaloreuser.statestring
Example:
24user.pincodestring
Example:
560037user.schoolstring
user.standardstring
Example:
0user.ed_backgroundstring
Example:
[{"qualification":"","yop":"","institution":""}]user.landlinenull
user.cf_1string
user.cf_2string
user.cf_3string
user.cf_4string
user.cf_5string
user.areanull
user.sourceinteger
Example:
1user.archived_statusstring[]
One
0/1 per organizationuser.timezonestring
Example:
(UTC+05:30) Asia/Calcuttauser.aboutstring
Example:
<p>Admin account for Instructor's Profile</p>
Example:
103Example:
+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:
243274Example:
212Example:
Languages KnownExample:
Enter the languages knownExample:
3Example:
kannadaExample:
3Example:
1Example:
253660user.custom_fields.form_typeinteger
Example:
3Example:
0Example:
1Example:
0Example:
0Example:
1Example:
1user.custom_fields.is_activeinteger
Example:
1Example:
4user.system_fieldsarray
Which built-in profile fields the organization has switched on
Notes: Only users who belong to one of your organizations can be read; anyone else returns "User not in institution.". Numbers inside the lists come back as strings. Rate limit: 30 requests per minute; going over locks you out for 30 minutes.