Docs home

Get User Details by External UUID

Finds a user by the external ID you stored for them (the `external_uuid` you set when creating the learner) and returns their full profile. Use it when your own system knows its ID for the person but not Edmingle's `user_id`.

GET/student/externaluuid/search
Get User Details by External UUID
curl --request GET \
  --url 'https://<your-api-host>/nuSource/api/v1/student/externaluuid/search?external_uuid=<uuid>' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>'
{
    "code": 200,
    "message": "Success",
    "user": {
        "user_id": 92225011,
        "name": "ShaPatel Patel",
        "email": "nimishapatel+234@edmingle.com",
        "contact_number": "8798788978",
        "contact_number_2": null,
        "user_username": "ShaPatel5636330",
        "organization_ids": [
            "1943"
        ],
        "address": "",
        "user_role": 1,
        "org_user_status": [
            "1"
        ],
        "url": "",
        "first_name": "",
        "last_name": "",
        "emergency_contact": "",
        "emergency_person": "",
        "gender": "",
        "birthday": "",
        "registration_numbers": [
            "230816590"
        ],
        "religion": null,
        "occupation": 0,
        "qualification": null,
        "u_parent_name": "",
        "u_parent_contact": "",
        "u_parent_email": "",
        "city": "",
        "state": "",
        "pincode": "",
        "school": "0",
        "standard": "0",
        "ed_background": "",
        "aadhaar_number": "",
        "landline": "",
        "alternate_email": "",
        "residential_address": "",
        "cf_1": "",
        "cf_2": "",
        "cf_3": "",
        "cf_4": "",
        "cf_5": "",
        "area": null,
        "source": 1,
        "archived_status": [
            "0"
        ],
        "timezone": "(UTC+05:30) Asia/Calcutta",
        "about": "",
        "contact_number_country_id": 103,
        "contact_number_2_country_id": null,
        "u_parent_contact_country_id": "",
        "date_user_added": 1753873409,
        "role_name": null,
        "role_id": 0,
        "super_admin": 0,
        "is_promotional_email_subscribed": null,
        "is_promotional_whatsapp_subscribed": null,
        "is_promotional_sms_subscribed": null,
        "is_promotional_push_subscribed": null,
        "external_uuid": "nimisha12",
        "contact_number_dial_code": "+91",
        "contact_number_2_dial_code": "",
        "u_parent_contact_country_dial_code": "",
        "document_name": [],
        "custom_fields": [
            {
                "field_id": 443241,
                "organization_id": 1943,
                "field_display_name": "Pre -Mandatory| File Upload | Offline",
                "field_help_text": "",
                "field_type": 5,
                "default_value": "",
                "possible_values": "[]",
                "field_name": "pre_-mandatory|_file_upload_|_offline",
                "original_form_type": 1,
                "field_value": "",
                "form_field_mapper_id": 451386,
                "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": 23
            },
            {
                "field_id": 443237,
                "organization_id": 1943,
                "field_display_name": "Pre -Mandatory| Text | Online",
                "field_help_text": "",
                "field_type": 1,
                "default_value": "",
                "possible_values": "[]",
                "field_name": "pre_-mandatory|_text_|_online",
                "original_form_type": 1,
                "field_value": "",
                "form_field_mapper_id": 451382,
                "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": 27
            },
            {
                "field_id": 443238,
                "organization_id": 1943,
                "field_display_name": "Pre -Mandatory| Number | Online",
                "field_help_text": "",
                "field_type": 2,
                "default_value": "",
                "possible_values": "[]",
                "field_name": "pre_-mandatory|_number_|_online",
                "original_form_type": 1,
                "field_value": "",
                "form_field_mapper_id": 451383,
                "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": 28
            },
            {
                "field_id": 443239,
                "organization_id": 1943,
                "field_display_name": "Pre -Mandatory| Dropdown | Online",
                "field_help_text": "",
                "field_type": 3,
                "default_value": "",
                "possible_values": "[{\"name\":\"ananth\",\"value\":1,\"status\":1},{\"name\":\"Anagha\",\"value\":2,\"status\":1},{\"name\":\"Amogh\",\"value\":3,\"status\":1}]",
                "field_name": "pre_-mandatory|_dropdown_|_online",
                "original_form_type": 1,
                "field_value": "",
                "form_field_mapper_id": 451384,
                "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": 29
            },
            {
                "field_id": 443240,
                "organization_id": 1943,
                "field_display_name": "Pre -Mandatory| Date| Online",
                "field_help_text": "",
                "field_type": 4,
                "default_value": "",
                "possible_values": "[]",
                "field_name": "pre_-mandatory|_date|_online",
                "original_form_type": 1,
                "field_value": "",
                "form_field_mapper_id": 451385,
                "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": 30
            },
            {
                "field_id": 486296,
                "organization_id": 1943,
                "field_display_name": "Scheme",
                "field_help_text": "",
                "field_type": 3,
                "default_value": "",
                "possible_values": "[{\"name\":\"Learn & Earn\",\"value\":1,\"status\":1},{\"name\":\"NAPS\",\"value\":2,\"status\":1},{\"name\":\"NATS\",\"value\":3,\"status\":1}]",
                "field_name": "scheme",
                "original_form_type": 1,
                "field_value": "",
                "form_field_mapper_id": 497744,
                "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": 31
            },
            {
                "field_id": 486297,
                "organization_id": 1943,
                "field_display_name": "Company Name",
                "field_help_text": "",
                "field_type": 1,
                "default_value": "",
                "possible_values": "[]",
                "field_name": "company_name",
                "original_form_type": 1,
                "field_value": "",
                "form_field_mapper_id": 497745,
                "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": 32
            },
            {
                "field_id": 497317,
                "organization_id": 1943,
                "field_display_name": "holaaaa",
                "field_help_text": "holaaaa",
                "field_type": 1,
                "default_value": "",
                "possible_values": "[]",
                "field_name": "holaaaa",
                "original_form_type": 1,
                "field_value": "",
                "form_field_mapper_id": 508593,
                "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": 33
            },
            {
                "field_id": 539993,
                "organization_id": 1943,
                "field_display_name": "TextNumner",
                "field_help_text": "",
                "field_type": 1,
                "default_value": "",
                "possible_values": "[]",
                "field_name": "textnumner",
                "original_form_type": 2,
                "field_value": "",
                "form_field_mapper_id": 550945,
                "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": 0,
                "display_index": 34
            },
            {
                "field_id": 539994,
                "organization_id": 1943,
                "field_display_name": "Manju Namo",
                "field_help_text": "",
                "field_type": 1,
                "default_value": "",
                "possible_values": "[]",
                "field_name": "manju_namo",
                "original_form_type": 1,
                "field_value": "",
                "form_field_mapper_id": 550946,
                "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": 36
            },
            {
                "field_id": 542706,
                "organization_id": 1943,
                "field_display_name": "country 1",
                "field_help_text": "",
                "field_type": 3,
                "default_value": "",
                "possible_values": "[{\"name\":\"India\",\"value\":1,\"status\":1},{\"name\":\"Middle East\",\"value\":2,\"status\":1},{\"name\":\"USA\",\"value\":3,\"status\":1}]",
                "field_name": "country_1",
                "original_form_type": 1,
                "field_value": "",
                "form_field_mapper_id": 553615,
                "form_type": 1,
                "system_field_setting": 0,
                "section_id": 1,
                "show_online": 1,
                "is_online_mandatory": 2,
                "show_offline": 1,
                "is_offline_mandatory": 2,
                "is_active": 1,
                "display_index": 37
            }
        ],
        "system_fields": [
            {
                "field_id": 102442,
                "field_name": "student_name",
                "is_active": 1,
                "show_offline": 1,
                "is_offline_mandatory": 1,
                "field_display_name": "Student Name",
                "system_field_type": 1
            },
            {
                "field_id": 102443,
                "field_name": "date_of_birth",
                "is_active": 1,
                "show_offline": 1,
                "is_offline_mandatory": 0,
                "field_display_name": "Date of Birth",
                "system_field_type": 4
            },
            {
                "field_id": 102444,
                "field_name": "student_email",
                "is_active": 1,
                "show_offline": 1,
                "is_offline_mandatory": 0,
                "field_display_name": "Student Email",
                "system_field_type": 1
            },
            {
                "field_id": 102446,
                "field_name": "alternate_contact",
                "is_active": 1,
                "show_offline": 1,
                "is_offline_mandatory": 0,
                "field_display_name": "Alternate Contact",
                "system_field_type": 1
            },
            {
                "field_id": 102447,
                "field_name": "permanent_address",
                "is_active": 1,
                "show_offline": 1,
                "is_offline_mandatory": 0,
                "field_display_name": "Permanent Address",
                "system_field_type": 1
            },
            {
                "field_id": 102450,
                "field_name": "pincode",
                "is_active": 1,
                "show_offline": 1,
                "is_offline_mandatory": 0,
                "field_display_name": "Pincode",
                "system_field_type": 2
            },
            {
                "field_id": 102451,
                "field_name": "student_source",
                "is_active": 1,
                "show_offline": 1,
                "is_offline_mandatory": 0,
                "field_display_name": "Student Source",
                "system_field_type": 3
            },
            {
                "field_id": 102452,
                "field_name": "religion",
                "is_active": 1,
                "show_offline": 1,
                "is_offline_mandatory": 0,
                "field_display_name": "Religion",
                "system_field_type": 3
            },
            {
                "field_id": 102453,
                "field_name": "standard",
                "is_active": 1,
                "show_offline": 1,
                "is_offline_mandatory": 0,
                "field_display_name": "Standard",
                "system_field_type": 1
            },
            {
                "field_id": 102454,
                "field_name": "occupation",
                "is_active": 1,
                "show_offline": 1,
                "is_offline_mandatory": 0,
                "field_display_name": "Occupation",
                "system_field_type": 3
            },
            {
                "field_id": 102460,
                "field_name": "area",
                "is_active": 1,
                "show_offline": 1,
                "is_offline_mandatory": 0,
                "field_display_name": "Area",
                "system_field_type": 3
            },
            {
                "field_id": 102461,
                "field_name": "school_college_name",
                "is_active": 1,
                "show_offline": 1,
                "is_offline_mandatory": 0,
                "field_display_name": "School/College Name",
                "system_field_type": 3
            },
            {
                "field_id": 102462,
                "field_name": "alternate_email",
                "is_active": 1,
                "show_offline": 0,
                "is_offline_mandatory": 0,
                "field_display_name": "Alternate Email",
                "system_field_type": 1
            },
            {
                "field_id": 102463,
                "field_name": "landline_no",
                "is_active": 1,
                "show_offline": 0,
                "is_offline_mandatory": 0,
                "field_display_name": "Landline No.",
                "system_field_type": 2
            },
            {
                "field_id": 102464,
                "field_name": "residential_address",
                "is_active": 1,
                "show_offline": 1,
                "is_offline_mandatory": 0,
                "field_display_name": "Residential Address",
                "system_field_type": 1
            },
            {
                "field_id": 102467,
                "field_name": "qualification",
                "is_active": 1,
                "show_offline": 0,
                "is_offline_mandatory": 0,
                "field_display_name": "Qualification",
                "system_field_type": 3
            },
            {
                "field_id": 102468,
                "field_name": "aadhaar_number",
                "is_active": 1,
                "show_offline": 0,
                "is_offline_mandatory": 0,
                "field_display_name": "Aadhar Number",
                "system_field_type": 1
            },
            {
                "field_id": 102469,
                "field_name": "upload_documents",
                "is_active": 1,
                "show_offline": 0,
                "is_offline_mandatory": 0,
                "field_display_name": "Upload Documents",
                "system_field_type": 5
            },
            {
                "field_id": 289606,
                "field_name": "country",
                "is_active": 0,
                "show_offline": 1,
                "is_offline_mandatory": 0,
                "field_display_name": "Country",
                "system_field_type": 1
            },
            {
                "field_id": 289607,
                "field_name": "cf_1",
                "is_active": 0,
                "show_offline": 0,
                "is_offline_mandatory": 0,
                "field_display_name": "cf_1",
                "system_field_type": 1
            },
            {
                "field_id": 289608,
                "field_name": "cf_2",
                "is_active": 0,
                "show_offline": 0,
                "is_offline_mandatory": 0,
                "field_display_name": "cf_2",
                "system_field_type": 1
            },
            {
                "field_id": 289609,
                "field_name": "cf_3",
                "is_active": 0,
                "show_offline": 0,
                "is_offline_mandatory": 0,
                "field_display_name": "cf_3",
                "system_field_type": 1
            },
            {
                "field_id": 289610,
                "field_name": "cf_4",
                "is_active": 0,
                "show_offline": 0,
                "is_offline_mandatory": 0,
                "field_display_name": "cf_4",
                "system_field_type": 1
            },
            {
                "field_id": 289611,
                "field_name": "cf_5",
                "is_active": 0,
                "show_offline": 0,
                "is_offline_mandatory": 0,
                "field_display_name": "cf_5",
                "system_field_type": 1
            },
            {
                "field_id": 289612,
                "field_name": "source",
                "is_active": 0,
                "show_offline": 1,
                "is_offline_mandatory": 0,
                "field_display_name": "Source",
                "system_field_type": 1
            },
            {
                "field_id": 102455,
                "field_name": "timezone",
                "is_active": 0,
                "show_offline": 1,
                "is_offline_mandatory": 0,
                "field_display_name": "TimeZone",
                "system_field_type": 3
            },
            {
                "field_id": 289605,
                "field_name": "username",
                "is_active": 1,
                "show_offline": 1,
                "is_offline_mandatory": 0,
                "field_display_name": "Username",
                "system_field_type": 1
            },
 

Access: Institute admins and tutors, plus custom roles that can view or list learners or that manage marketing campaigns.

Query parameters
external_uuidstringrequired
Your ID for the user. Leading and trailing spaces are trimmed. A + in the value is kept as a literal plus sign, but encode other special characters.

Response: Same shape as "Retrieve a Student". user holds the profile: user_id, name, email, user_username, contact_number and contact_number_2 (with contact_number_country_id, contact_number_2_country_id and the matching *_dial_code), organization_ids (the organizations you share with this user), user_role (0 tutor, 1 learner, 2 admin, 7 custom role), role_id and role_name (custom role, if any), super_admin (1 if they are an institute admin), org_user_status (one value per organization; for learners 1 Registered, 2 Admitted, 3 Completed, 4 On leave; for staff 1 accepted, 0 invite pending), archived_status (one 0/1 per organization), registration_numbers, external_uuid, personal details (gender, birthday, address, residential_address, city, state, pincode, school, standard, qualification, occupation, religion, aadhaar_number, landline, alternate_email, emergency_contact, emergency_person, about), the five spare fields cf_1 to cf_5, the guardian (u_parent_name, u_parent_email, u_parent_contact, u_parent_contact_country_id), timezone, source, date_user_added (Unix timestamp), the marketing opt-ins is_promotional_email_subscribed, is_promotional_whatsapp_subscribed, is_promotional_sms_subscribed, is_promotional_push_subscribed, and url (profile picture). It also carries document_name (uploaded documents with download links), custom_fields (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 links) and system_fields (which built-in profile fields the organization has switched on).

Notes: Searches only the institute that your ORGID organization belongs to. Returns "User Details Not Found" when no user there has this external ID, and "User not in institution." when the user exists but shares none of your organizations. Rate limit: 30 requests per minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI