Retrieve Profile Details
Returns the profile and account context of the user who owns the API key: personal details, the organizations they belong to with their role in each, the institute's plan settings, and (for learners) their course enrollments. Use it right after login to find out who you are and which organizations you can act in.
GET
/user/usermetaRetrieve Profile Details
curl --request GET \
--url 'https://<your-api-host>/nuSource/api/v1/user/usermeta' \
--header 'APIKEY: <your-api-key>' \
--header 'ORGID: <your-org-id>'{
"code": 200,
"message": "Success",
"user": {
"user_id": 1,
"name": " Gaurav Kapoor",
"username": "harshit",
"email": "harshit@edmingle.com",
"isAssignmentsEnabled": 0,
"isQuizesEnabled": 0,
"language": "en",
"onboarding": 1,
"signup_confirmed": 1,
"country": "IN",
"course_onboarding": 1,
"feedback_submitted": 0,
"is_super_admin": 1,
"is_parent": null,
"profile_picture_id": 108026,
"img_url": "https://d15g8b7hr8be7w.cloudfront.net/User(1)/108026-Screenshot_from_2022-04-28_14-39-00.png",
"custom_form_filled": 1,
"number_verified": 1,
"first_name": "",
"last_name": "",
"level": 0,
"exp": 0,
"credits": 0,
"contact_number": "9437855924",
"contact_number_2": "9437855923",
"address": "#4, 008, You are not invited here, bangalore-560078",
"emergency_contact": "",
"emergency_person": "",
"gender": "1",
"occupation": 0,
"birthday": -918538200,
"freshchart_resume_id": "",
"is_tutor_tnc_enabled": null,
"google_id": "102292201994083266227",
"new_release_notes": 0,
"contact_number_country_id": 103,
"contact_number_2_country_id": 103,
"automatic_timezone_selection": 2,
"contact_number_dial_code": "+91",
"contact_number_2_dial_code": "+91",
"timezone": "America/Adak",
"institution_id": 1,
"is_institution_admin": 1,
"alternate_login": 0,
"org_data": [
{
"role": "admin",
"organization_id": 2,
"organization_name": "Edmingle",
"institution_id": 1,
"institution_name": "Institution 1",
"organization_state": "KARNATAKA",
"organization_contact_number": "9898987766",
"organization_contact_number_country_id": null,
"organization_contact_number_dial_code": "",
"justdial_link": "",
"fb_link": "",
"youtube_link": "",
"google_business_link": "",
"status": "Accepted",
"is_freshchat_enabled": 1,
"portal_name": "edmingle",
"organization_currency": 1,
"currency_id": 1,
"currency_symbol": "$"
},
{
"role": "admin",
"organization_id": 27,
"organization_name": "Online",
"institution_id": 1,
"institution_name": "Institution 1",
"organization_state": "UTTAR PRADESH",
"organization_contact_number": null,
"organization_contact_number_country_id": null,
"organization_contact_number_dial_code": "",
"justdial_link": "",
"fb_link": "",
"youtube_link": "",
"google_business_link": "",
"status": "Accepted",
"is_freshchat_enabled": 1,
"portal_name": "edmingle",
"organization_currency": 1,
"currency_id": 49,
"currency_symbol": "₹"
},
{
"role": "admin",
"organization_id": 49,
"organization_name": "New Branch 1",
"institution_id": 1,
"institution_name": "Institution 1",
"organization_state": "ASSAM",
"organization_contact_number": "8870686747",
"organization_contact_number_country_id": null,
"organization_contact_number_dial_code": "",
"justdial_link": "",
"fb_link": "",
"youtube_link": "",
"google_business_link": "",
"status": "Accepted",
"is_freshchat_enabled": 1,
"portal_name": "edmingle",
"organization_currency": 4,
"currency_id": 4,
"currency_symbol": "AED"
},
{
"role": "admin",
"organization_id": 71,
"organization_name": "Enq Branch",
"institution_id": 1,
"institution_name": "Institution 1",
"organization_state": "",
"organization_contact_number": null,
"organization_contact_number_country_id": null,
"organization_contact_number_dial_code": "",
"justdial_link": "",
"fb_link": "",
"youtube_link": "",
"google_business_link": "",
"status": "Accepted",
"is_freshchat_enabled": 1,
"portal_name": "edmingle",
"organization_currency": 1,
"currency_id": 49,
"currency_symbol": "₹"
},
{
"role": "admin",
"organization_id": 72,
"organization_name": "Khunga Leads Custom fields",
"institution_id": 1,
"institution_name": "Institution 1",
"organization_state": "",
"organization_contact_number": null,
"organization_contact_number_country_id": null,
"organization_contact_number_dial_code": "",
"justdial_link": "",
"fb_link": "",
"youtube_link": "",
"google_business_link": "",
"status": "Accepted",
"is_freshchat_enabled": 1,
"portal_name": "edmingle",
"organization_currency": 1,
"currency_id": 49,
"currency_symbol": "₹"
},
{
"role": "admin",
"organization_id": 73,
"organization_name": "Custom Field Testing",
"institution_id": 1,
"institution_name": "Institution 1",
"organization_state": "",
"organization_contact_number": null,
"organization_contact_number_country_id": null,
"organization_contact_number_dial_code": "",
"justdial_link": "",
"fb_link": "",
"youtube_link": "",
"google_business_link": "",
"status": "Accepted",
"is_freshchat_enabled": 1,
"portal_name": "edmingle",
"organization_currency": 1,
"currency_id": 49,
"currency_symbol": "₹"
},
{
"role": "admin",
"organization_id": 74,
"organization_name": "Khunga Academy",
"institution_id": 1,
"institution_name": "Institution 1",
"organization_state": "",
"organization_contact_number": null,
"organization_contact_number_country_id": null,
"organization_contact_number_dial_code": "",
"justdial_link": "",
"fb_link": "",
"youtube_link": "",
"google_business_link": "",
"status": "Accepted",
"is_freshchat_enabled": 1,
"portal_name": "edmingle",
"organization_currency": 1,
"currency_id": 49,
"currency_symbol": "₹"
},
{
"role": "admin",
"organization_id": 75,
"organization_name": "New Enq Branch",
"institution_id": 1,
"institution_name": "Institution 1",
"organization_state": "",
"organization_contact_number": null,
"organization_contact_number_country_id": null,
"organization_contact_number_dial_code": "",
"justdial_link": "",
"fb_link": "",
"youtube_link": "",
"google_business_link": "",
"status": "Accepted",
"is_freshchat_enabled": 1,
"portal_name": "edmingle",
"organization_currency": 1,
"currency_id": 49,
"currency_symbol": "₹"
},
{
"role": "admin",
"organization_id": 92,
"organization_name": "custom testing branch",
"institution_id": 1,
"institution_name": "Institution 1",
"organization_state": "",
"organization_contact_number": "9745455545",
"organization_contact_number_country_id": null,
"organization_contact_number_dial_code": "",
"justdial_link": "",
"fb_link": "",
"youtube_link": "",
"google_business_link": "",
"status": "Accepted",
"is_freshchat_enabled": 1,
"portal_name": "edmingle",
"organization_currency": 1,
"currency_id": 49,
"currency_symbol": "₹"
},
{
"role": "admin",
"organization_id": 95,
"organization_name": "Custom Signup",
"institution_id": 1,
"institution_name": "Institution 1",
"organization_state": "",
"organization_contact_number": null,
"organization_contact_number_country_id": null,
"organization_contact_number_dial_code": "",
"justdial_link": "",
"fb_link": "",
"youtube_link": "",
"google_business_link": "",
"status": "Accepted",
"is_freshchat_enabled": 1,
"portal_name": "edmingle",
"organization_currency": 1,
"currency_id": 49,
"currency_symbol": "₹"
},
{
"role": "admin",
"organization_id": 96,
"organization_name": "Testing Branch for exports",
"institution_id": 1,
"institution_name": "Institution 1",
"organization_state": "DELHI",
"organization_contact_number": "9865784561",
"organization_contact_number_country_id": null,
"organization_contact_number_dial_code": "",
"justdial_link": "",
"fb_link": "",
"youtube_link": "",
"google_business_link": "",
"status": "Accepted",
"is_freshchat_enabled": 1,
"portal_name": "edmingle",
"organization_currency": 1,
"currency_id": 49,
"currency_symbol": "₹"
},
{
"role": "admin",
"organization_id": 99,
"organization_name": "New Branch One",
"institution_id": 1,
"institution_name": "Institution 1",
"organization_state": "",
"organization_contact_number": null,
"organization_contact_number_country_id": null,
"organization_contact_number_dial_code": "",
"justdial_link": "",
"fb_link": "",
"youtube_link": "",
"google_business_link": "",
"status": "Accepted",
"is_freshchat_enabled": 1,
"portal_name": "edmingle",
"organization_currency": 1,
"currency_id": 49,
"currency_symbol": "₹"
},
{
"role": "admin",
"organization_id": 100,
"organization_name": "New Branch two",
"institution_id": 1,
"institution_name": "Institution 1",
"organization_state": "",
"organization_contact_number": null,
"organization_contact_number_country_id": null,
"organization_contact_number_dial_code": "",
"justdial_link": "",
"fb_link": "",
"youtube_link": "",
"google_business_link": "",
"status": "Accepted",
"is_freshchat_enabled": 1,
"portal_name": "edmingle",
"organization_currency": 1,
"currency_id": 49,
"currency_symbol": "₹"
},
{
"role": "admin",
"organization_id": 101,
"organization_name": "New Branch three",
"institution_id": 1,
"institution_name": "Institution 1",
"organization_state": "",
"organization_contact_number": null,
"organization_contact_number_country_id": null,
"organization_contact_number_dial_code": "",
"justdial_link": "",
"fb_link": "",
"youtube_link": "",
"google_business_link": "",
"status": "Accepted",
"is_freshchat_enabled": 1,
"portal_name": "edmingle",
"organization_currency": 1,
"currency_id": 49,
"currency_symbol": "₹"
},
{
"role": "admin",
"organization_id": 102,
"organization_name": "Filters Testing Branch",
"institution_id": 1,
"institution_name": "Institution 1",
"organization_state": "",
"organization_contact_number": "8938838773",
"organization_contact_number_country_id": null,
"organization_contact_number_dial_code": "",
"justdial_link": "",
"fb_link": "",
"youtube_link": "",
"google_business_link": "",
"status": "Accepted",
"is_freshchat_enabled": 1,
"portal_name": "edmingle",
"organization_currency": 1,
"currency_id": 49,
"currency_symbol": "₹"
},
{
"role": "admin",
"organization_id": 121,
"organization_name": "Updates Testing Branch",
"institution_id": 1,
"institution_name": "Institution 1",
"organization_state": "KARNATAKA",
"organization_contact_number": "1234567890",
"organization_contact_number_country_id": null,
"organization_contact_number_dial_code": "",
"justdial_link": "",
"fb_link": "",
"youtube_link": "",
"google_business_link": "",
"status": "Accepted",
"is_freshchat_enabled": 1,
"portal_name": "edmingle",
"organization_currency": 1,
"currency_id": 49,
"currency_symbol": "₹"
},
{
"role": "admin",
"organization_id": 122,
"organization_name": "New Branch Four",
"institution_id": 1,
"institution_name": "Institution 1",
"organization_state": "",
"organization_contact_number": null,
"organization_contact_number_country_id": null,
"organization_contact_number_dial_code": "",
"justdial_link": "",
"fb_link": "",
"youtube_link": "",
"google_business_link": "",
"status": "Accepted",
"is_freshchat_enabled": 1,
"portal_name": "edmingle",
"organization_currency": 1,
"currency_id": 49,
"currency_symbol": "₹"
},
{
"role": "admin",
"organization_id": 298,
"organization_name": "B2",
"institution_id": 1,
"institution_name": "Institution 1",
"organization_state": "",
"organization_contact_number": "",
"organization_contact_number_country_id": null,
"organization_contact_number_dial_code": "",
"justdial_link": "",
"fb_link": "",
"youtube_link": "",
"google_business_link": "",
"status": "Accepted",
"is_freshchat_enabled": 1,
"portal_name": "edmingle",
"organization_currency": 1,
"currency_id": 49,
"currency_symbol": "₹"
},
{
"role": "admin",
"organization_id": 311,
"organization_name": "DuplicateCourseBranch",
"institution_id": 1,
"institution_name": "Institution 1",
"organization_state": "MEGHLAYA",
"organization_contact_number": "6505130514",
"organization_contact_number_country_id": 40,
"organization_contact_number_dial_code": "+1",
"justdial_link": "",
"fb_link": "",
"youtube_link": "",
"google_business_link": "",
"status": "Accepted",
"is_freshchat_enabled": 1,
"portal_name": "edmingle",
"organization_currency": 1,
"currency_id": 49,
"currency_symbol": "₹"
},
{
"role": "admin",
"organization_id": 395,
"organization_name": "tessfsd dadasd",
"institution_id": 1,
"institution_name": "Institution 1",
"organization_state": "",
"organization_contact_number": "6505130518",
"organization_contact_number_country_id": 40,
"organization_contact_number_dial_code": "+1",
"justdial_link": "",
"fb_link": "",
"youtube_link": "",
"google_business_link": "",
"status": "Accepted",
"is_freshchat_enabled": 1,
"portal_name": "edmingle",
"organization_currency": 1,
"currency_id": 49,
"currency_symbol": "₹"
},
{
"role": "admin",
"organization_id": 396,
"organization_name": "tesfaff",
"institution_id": 1,
"institution_name": "Institution 1",
"organization_state": "",
"organization_contact_number": "6505130512",
"organization_contact_number_country_id": 40,
"organization_contact_number_dial_code": "+1",
"justdial_link": "",
"fb_link": "",
"youtube_link": "",
"google_business_link": "",
"status": "Accepted",
"is_freshchat_enabled": 1,
"portal_name": "edmingle",
"organization_currency": 1,
"currency_id": 49,
"currency_symbol": "₹"
},
{
"role": "admin",
"organization_id": 397,
"organization_name": "newbarmch26",
"institution_id": 1,
"institution_name": "Institution 1",
Access: Any logged-in user. The ORGID header is optional for this endpoint.
Response:
user:user_id,name,username,email,contact_number,contact_number_2(with country IDs and dial codes),language/language_iso,country,timezone,gender,birthday,address,img_url,profile_picture_id,created_on(Unix timestamp),password_updated_at,is_institution_admin(1for institute admins, withinstitution_id),alternate_login(linked account ID or0),institution_currency,plan_settings,plandetails(trial status and days left),warnings(storage warnings for admins), and onboarding flags such assignup_confirmed,number_verifiedandcustom_form_filled.user.org_data: one entry per organization, withorganization_id,organization_name,institution_id,institution_name,role(tutor,student,admin,parentor the custom role name),role_id,scope(the permission keys the user holds),status(AcceptedorPending),registration_number,organization_currency,currency_id,currency_symbol,actual_domain,subdomain, and social links.- For learners:
user_classes(class IDs),user_bundles(course ID to enrollment status),free_enrolment_institution_bundle_idandnum_packages. For parents:child_ids. For staff:user.if_tutor_accepted_tnc. channels(notification channel names),notification_count(always0),woolf_infoandis_zoho_asap_enabled.
Notes: Institute admins get every organization of the institute in org_data, with role admin. Archived memberships are left out for everyone else. Rate limit: 30 requests per minute; going over locks you out for 30 minutes.