Docs home

User Profile / UserMeta

Returns the profile and account context of the logged-in learner: personal details, organizations, plan settings, and their course enrollments. This is the same endpoint as "Retrieve Profile Details", called with a learner's API key.

GET/user/usermeta
User Profile / UserMeta
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": 91139236,
        "name": "Asit Update",
        "username": "Asit9679054",
        "email": "hemal+test9809@edmingle.com",
        "isAssignmentsEnabled": 0,
        "isQuizesEnabled": 0,
        "language": "en",
        "onboarding": 0,
        "signup_confirmed": 1,
        "country": "IN",
        "course_onboarding": 0,
        "feedback_submitted": 0,
        "is_super_admin": 0,
        "is_parent": null,
        "profile_picture_id": 100000,
        "img_url": "",
        "custom_form_filled": 1,
        "number_verified": 1,
        "first_name": "",
        "last_name": "",
        "level": 0,
        "exp": 0,
        "credits": 0,
        "contact_number": "7898093461",
        "contact_number_2": null,
        "address": "",
        "emergency_contact": "",
        "emergency_person": "",
        "gender": "1",
        "occupation": null,
        "birthday": null,
        "freshchart_resume_id": "",
        "is_tutor_tnc_enabled": null,
        "google_id": null,
        "new_release_notes": 1,
        "contact_number_country_id": 103,
        "contact_number_2_country_id": 103,
        "automatic_timezone_selection": 2,
        "password_updated_at": 1780995753,
        "show_student_my_purchases": 1,
        "created_on": 1728560774,
        "language_iso": "en",
        "ai_allowed": 0,
        "companion_allowed": 0,
        "contact_number_dial_code": "+91",
        "contact_number_2_dial_code": "+91",
        "timezone": "Asia/Calcutta",
        "is_institution_admin": 0,
        "alternate_login": 0,
        "org_data": [
            {
                "role": "student",
                "role_id": 0,
                "scope": [
                    "role:student"
                ],
                "organization_id": 212,
                "organization_name": "Academics (K 12) School",
                "institution_id": 126,
                "institution_name": "demo. Academy Edmingle",
                "organization_state": "BIHAR",
                "organization_contact_number": "9099654435",
                "organization_contact_number_country_id": 103,
                "organization_contact_number_dial_code": "+91",
                "justdial_link": "",
                "fb_link": "",
                "youtube_link": "",
                "google_business_link": "",
                "status": null,
                "is_freshchat_enabled": 0,
                "portal_name": "prashant",
                "organization_currency": 1,
                "registration_number": "1234",
                "is_organization_level_domain_enabled": 0,
                "is_session_feedback_mandatory": 0,
                "actual_domain": "",
                "subdomain": "",
                "currency_id": 49,
                "currency_symbol": "โ‚น"
            },
            {
                "role": "student",
                "role_id": 0,
                "scope": [
                    "role:student"
                ],
                "organization_id": 214,
                "organization_name": "Vocational Courses",
                "institution_id": 126,
                "institution_name": "demo. Academy Edmingle",
                "organization_state": "KARNATAKA",
                "organization_contact_number": null,
                "organization_contact_number_country_id": 103,
                "organization_contact_number_dial_code": "+91",
                "justdial_link": "",
                "fb_link": "",
                "youtube_link": "",
                "google_business_link": "",
                "status": "Accepted",
                "is_freshchat_enabled": 0,
                "portal_name": "prashant",
                "organization_currency": 1,
                "registration_number": "78979723249",
                "is_organization_level_domain_enabled": 0,
                "is_session_feedback_mandatory": 1,
                "actual_domain": "",
                "subdomain": "",
                "currency_id": 49,
                "currency_symbol": "โ‚น"
            },
            {
                "role": "student",
                "role_id": 0,
                "scope": [
                    "role:student"
                ],
                "organization_id": 241,
                "organization_name": "K12 online",
                "institution_id": 126,
                "institution_name": "demo. Academy Edmingle",
                "organization_state": "",
                "organization_contact_number": "9874439574",
                "organization_contact_number_country_id": 103,
                "organization_contact_number_dial_code": "+91",
                "justdial_link": "",
                "fb_link": "",
                "youtube_link": "",
                "google_business_link": "",
                "status": null,
                "is_freshchat_enabled": 0,
                "portal_name": "prashant",
                "organization_currency": 1,
                "registration_number": "4544",
                "is_organization_level_domain_enabled": 0,
                "is_session_feedback_mandatory": 0,
                "actual_domain": "",
                "subdomain": "",
                "currency_id": 49,
                "currency_symbol": "โ‚น"
            }
        ],
        "institution_currency": 1,
        "plan_settings": [
            {
                "id": 172750,
                "setting_id": 357,
                "setting_key": "fee_free_course",
                "setting_value": "0",
                "data_type": "NUMBER",
                "plan_level": 5
            },
            {
                "id": 172751,
                "setting_id": 358,
                "setting_key": "fee_paid_course",
                "setting_value": "0",
                "data_type": "NUMBER",
                "plan_level": 5
            },
            {
                "id": 172752,
                "setting_id": 359,
                "setting_key": "payout_schedule",
                "setting_value": "1",
                "data_type": "NUMBER",
                "plan_level": 5
            },
            {
                "id": 172753,
                "setting_id": 360,
                "setting_key": "num_students",
                "setting_value": "99999",
                "data_type": "NUMBER",
                "plan_level": 5
            },
            {
                "id": 172754,
                "setting_id": 361,
                "setting_key": "num_courses",
                "setting_value": "9999",
                "data_type": "NUMBER",
                "plan_level": 5
            },
            {
                "id": 172755,
                "setting_id": 362,
                "setting_key": "storage_limit",
                "setting_value": "10",
                "data_type": "NUMBER",
                "plan_level": 5
            },
            {
                "id": 172756,
                "setting_id": 363,
                "setting_key": "bandwidth_limit",
                "setting_value": "1000",
                "data_type": "NUMBER",
                "plan_level": 5
            },
            {
                "id": 172757,
                "setting_id": 364,
                "setting_key": "is_full_whitelabeled",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172758,
                "setting_id": 365,
                "setting_key": "show_edmingle_branding",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172759,
                "setting_id": 366,
                "setting_key": "android_app_enabled",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172760,
                "setting_id": 367,
                "setting_key": "ios_app_enabled",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172761,
                "setting_id": 368,
                "setting_key": "video_offline_enabled",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172762,
                "setting_id": 369,
                "setting_key": "screen_record_restriction",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172763,
                "setting_id": 370,
                "setting_key": "num_tutors",
                "setting_value": "15",
                "data_type": "NUMBER",
                "plan_level": 5
            },
            {
                "id": 172764,
                "setting_id": 371,
                "setting_key": "num_admins",
                "setting_value": "5",
                "data_type": "NUMBER",
                "plan_level": 5
            },
            {
                "id": 172765,
                "setting_id": 372,
                "setting_key": "live_class_enabled",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172766,
                "setting_id": 373,
                "setting_key": "zoom_recording_enabled",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172767,
                "setting_id": 374,
                "setting_key": "teaching_material_enabled",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172768,
                "setting_id": 375,
                "setting_key": "assignments_enabled",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172769,
                "setting_id": 376,
                "setting_key": "exercise_enabled",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172770,
                "setting_id": 377,
                "setting_key": "external_links_enabled",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172771,
                "setting_id": 378,
                "setting_key": "video_library_enabled",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172772,
                "setting_id": 379,
                "setting_key": "course_free_preview_enabled",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172773,
                "setting_id": 380,
                "setting_key": "bundles_enabled",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172774,
                "setting_id": 381,
                "setting_key": "crs_categorization_enabled",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172775,
                "setting_id": 382,
                "setting_key": "lesson_availability",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172776,
                "setting_id": 383,
                "setting_key": "privacy_control",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172777,
                "setting_id": 384,
                "setting_key": "prerequisites_enabled",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172778,
                "setting_id": 385,
                "setting_key": "drip_content_enabled",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172779,
                "setting_id": 386,
                "setting_key": "qb_enabled",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172780,
                "setting_id": 387,
                "setting_key": "ques_randomization_enabled",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172781,
                "setting_id": 388,
                "setting_key": "printable_tests",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172782,
                "setting_id": 389,
                "setting_key": "multi_batches",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172783,
                "setting_id": 390,
                "setting_key": "batch_scheduling",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172784,
                "setting_id": 391,
                "setting_key": "sms_enabled",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172785,
                "setting_id": 392,
                "setting_key": "email_enabled",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172786,
                "setting_id": 393,
                "setting_key": "compiler_enabled",
                "setting_value": "0",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172787,
                "setting_id": 394,
                "setting_key": "site_builder",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172788,
                "setting_id": 395,
                "setting_key": "website_custom_pages",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172789,
                "setting_id": 396,
                "setting_key": "custom_domain",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172790,
                "setting_id": 397,
                "setting_key": "custom_js",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172791,
                "setting_id": 398,
                "setting_key": "custom_css",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172792,
                "setting_id": 399,
                "setting_key": "custom_signup_form",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172793,
                "setting_id": 400,
                "setting_key": "multi_login_restricted",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172794,
                "setting_id": 401,
                "setting_key": "edmingle_pg",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172795,
                "setting_id": 402,
                "setting_key": "custom_pg_rzp",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172796,
                "setting_id": 403,
                "setting_key": "custom_pg_instamojo",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172797,
                "setting_id": 404,
                "setting_key": "custom_pg_paytm",
                "setting_value": "0",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172798,
                "setting_id": 405,
                "setting_key": "custom_pg_ccavenue",
                "setting_value": "0",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172799,
                "setting_id": 406,
                "setting_key": "custom_pg_payumoney",
                "setting_value": "0",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172800,
                "setting_id": 407,
                "setting_key": "custom_pricing_plans",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172801,
                "setting_id": 408,
                "setting_key": "fee_tracking",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172802,
                "setting_id": 409,
                "setting_key": "enquiry_system",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172803,
                "setting_id": 410,
                "setting_key": "promo_codes",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172804,
                "setting_id": 411,
                "setting_key": "referral_system",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172805,
                "setting_id": 412,
                "setting_key": "bulk_teacher_upload",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                "id": 172806,
                "setting_id": 413,
                "setting_key": "manual_student_enrolment",
                "setting_value": "1",
                "data_type": "BOOLEAN",
                "plan_level": 5
            },
            {
                

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, created_on (Unix timestamp), password_updated_at, plan_settings, plandetails, and onboarding flags such as signup_confirmed, number_verified and custom_form_filled.
  • user.org_data: one entry per organization the learner belongs to, with organization_id, organization_name, institution_id, institution_name, role (student), scope, status (Accepted or Pending), registration_number, organization_currency, currency_symbol, actual_domain and subdomain.
  • user_classes: class IDs the learner is in. user_bundles: course ID mapped to enrollment status. free_enrolment_institution_bundle_id: courses the learner joined on a free enrollment. num_packages: number of paid course enrollments.
  • channels (notification channel names), notification_count (always 0), woolf_info and is_zoho_asap_enabled.

Notes: Archived organization memberships are left out. Rate limit: 30 requests per minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI