Docs home

Profile Custom and System Field

Returns the logged-in user's profile form: every built-in (system) and custom profile field the organization uses, with the user's current value in each. Use it to build an edit-profile screen, then save changes with "Update Profile".

GET/user/profileinfo
Profile Custom and System Field
curl --request GET \
  --url 'https://<your-api-host>/nuSource/api/v1/user/profileinfo' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>'
{
    "code": 200,
    "message": "Success",
    "user": {
        "document_name": [],
        "system_fields": [
            {
                "field_id": 12291,
                "organization_id": 212,
                "field_display_name": "Student Name",
                "field_help_text": "",
                "field_type": 1,
                "default_value": "",
                "possible_values": "",
                "field_name": "student_name",
                "original_form_type": 1,
                "field_value": "Asit Update",
                "form_field_mapper_id": 25247,
                "form_type": 1,
                "system_field_setting": 1,
                "section_id": 1,
                "show_online": 1,
                "is_online_mandatory": 1,
                "show_offline": 1,
                "is_offline_mandatory": 1,
                "is_active": 1,
                "display_index": 0,
                "extraInfo": []
            },
            {
                "field_id": 12318,
                "organization_id": 212,
                "field_display_name": "Upload Documents",
                "field_help_text": "",
                "field_type": 5,
                "default_value": "",
                "possible_values": "",
                "field_name": "upload_documents",
                "original_form_type": 1,
                "field_value": null,
                "form_field_mapper_id": 25245,
                "form_type": 1,
                "system_field_setting": 2,
                "section_id": 1,
                "show_online": 0,
                "is_online_mandatory": 0,
                "show_offline": 0,
                "is_offline_mandatory": 0,
                "is_active": 1,
                "display_index": 0,
                "extraInfo": []
            },
            {
                "field_id": 274830,
                "organization_id": 212,
                "field_display_name": "Country",
                "field_help_text": "",
                "field_type": 1,
                "default_value": "",
                "possible_values": "",
                "field_name": "country",
                "original_form_type": 1,
                "field_value": "",
                "form_field_mapper_id": 284684,
                "form_type": 1,
                "system_field_setting": 1,
                "section_id": 1,
                "show_online": 1,
                "is_online_mandatory": 0,
                "show_offline": 1,
                "is_offline_mandatory": 0,
                "is_active": 0,
                "display_index": 0
            },
            {
                "field_id": 274831,
                "organization_id": 212,
                "field_display_name": "cf_1",
                "field_help_text": "",
                "field_type": 1,
                "default_value": "",
                "possible_values": "",
                "field_name": "cf_1",
                "original_form_type": 1,
                "field_value": null,
                "form_field_mapper_id": 284685,
                "form_type": 1,
                "system_field_setting": 1,
                "section_id": 1,
                "show_online": 0,
                "is_online_mandatory": 0,
                "show_offline": 0,
                "is_offline_mandatory": 0,
                "is_active": 0,
                "display_index": 0,
                "extraInfo": []
            },
            {
                "field_id": 274832,
                "organization_id": 212,
                "field_display_name": "cf_2",
                "field_help_text": "",
                "field_type": 1,
                "default_value": "",
                "possible_values": "",
                "field_name": "cf_2",
                "original_form_type": 1,
                "field_value": null,
                "form_field_mapper_id": 284686,
                "form_type": 1,
                "system_field_setting": 1,
                "section_id": 1,
                "show_online": 0,
                "is_online_mandatory": 0,
                "show_offline": 0,
                "is_offline_mandatory": 0,
                "is_active": 0,
                "display_index": 0,
                "extraInfo": []
            },
            {
                "field_id": 274833,
                "organization_id": 212,
                "field_display_name": "cf_3",
                "field_help_text": "",
                "field_type": 1,
                "default_value": "",
                "possible_values": "",
                "field_name": "cf_3",
                "original_form_type": 1,
                "field_value": null,
                "form_field_mapper_id": 284687,
                "form_type": 1,
                "system_field_setting": 1,
                "section_id": 1,
                "show_online": 0,
                "is_online_mandatory": 0,
                "show_offline": 0,
                "is_offline_mandatory": 0,
                "is_active": 0,
                "display_index": 0,
                "extraInfo": []
            },
            {
                "field_id": 274834,
                "organization_id": 212,
                "field_display_name": "cf_4",
                "field_help_text": "",
                "field_type": 1,
                "default_value": "",
                "possible_values": "",
                "field_name": "cf_4",
                "original_form_type": 1,
                "field_value": null,
                "form_field_mapper_id": 284688,
                "form_type": 1,
                "system_field_setting": 1,
                "section_id": 1,
                "show_online": 0,
                "is_online_mandatory": 0,
                "show_offline": 0,
                "is_offline_mandatory": 0,
                "is_active": 0,
                "display_index": 0,
                "extraInfo": []
            },
            {
                "field_id": 274835,
                "organization_id": 212,
                "field_display_name": "cf_5",
                "field_help_text": "",
                "field_type": 1,
                "default_value": "",
                "possible_values": "",
                "field_name": "cf_5",
                "original_form_type": 1,
                "field_value": null,
                "form_field_mapper_id": 284689,
                "form_type": 1,
                "system_field_setting": 1,
                "section_id": 1,
                "show_online": 0,
                "is_online_mandatory": 0,
                "show_offline": 0,
                "is_offline_mandatory": 0,
                "is_active": 0,
                "display_index": 0,
                "extraInfo": []
            },
            {
                "field_id": 274836,
                "organization_id": 212,
                "field_display_name": "Source",
                "field_help_text": "",
                "field_type": 1,
                "default_value": "",
                "possible_values": "",
                "field_name": "source",
                "original_form_type": 1,
                "field_value": "",
                "form_field_mapper_id": 284690,
                "form_type": 1,
                "system_field_setting": 1,
                "section_id": 1,
                "show_online": 0,
                "is_online_mandatory": 0,
                "show_offline": 1,
                "is_offline_mandatory": 0,
                "is_active": 0,
                "display_index": 0
            },
            {
                "field_id": 32997,
                "organization_id": 212,
                "field_display_name": "TimeZone",
                "field_help_text": "",
                "field_type": 3,
                "default_value": "",
                "possible_values": "[]",
                "field_name": "timezone",
                "original_form_type": 1,
                "field_value": "(UTC+05:30) Asia/Calcutta",
                "form_field_mapper_id": 45168,
                "form_type": 1,
                "system_field_setting": 2,
                "section_id": 1,
                "show_online": 0,
                "is_online_mandatory": 0,
                "show_offline": 1,
                "is_offline_mandatory": 0,
                "is_active": 0,
                "display_index": 215,
                "extraInfo": []
            },
            {
                "field_id": 12309,
                "organization_id": 212,
                "field_display_name": "Area",
                "field_help_text": "",
                "field_type": 3,
                "default_value": "",
                "possible_values": "[]",
                "field_name": "area",
                "original_form_type": 1,
                "field_value": null,
                "form_field_mapper_id": 25236,
                "form_type": 1,
                "system_field_setting": 2,
                "section_id": 1,
                "show_online": 0,
                "is_online_mandatory": 0,
                "show_offline": 0,
                "is_offline_mandatory": 0,
                "is_active": 1,
                "display_index": 335,
                "extraInfo": []
            },
            {
                "field_id": 12296,
                "organization_id": 212,
                "field_display_name": "Permanent Address",
                "field_help_text": "",
                "field_type": 1,
                "default_value": "",
                "possible_values": "[]",
                "field_name": "permanent_address",
                "original_form_type": 1,
                "field_value": "",
                "form_field_mapper_id": 25252,
                "form_type": 1,
                "system_field_setting": 2,
                "section_id": 1,
                "show_online": 0,
                "is_online_mandatory": 0,
                "show_offline": 0,
                "is_offline_mandatory": 0,
                "is_active": 1,
                "display_index": 343,
                "extraInfo": []
            },
            {
                "field_id": 12310,
                "organization_id": 212,
                "field_display_name": "School/College Name",
                "field_help_text": "",
                "field_type": 3,
                "default_value": "",
                "possible_values": "[{\"name\":\"Pune University\",\"value\":1,\"status\":1},{\"name\":\"Gujarat University\",\"value\":2,\"status\":1}]",
                "field_name": "school_college_name",
                "original_form_type": 1,
                "field_value": 0,
                "form_field_mapper_id": 25237,
                "form_type": 1,
                "system_field_setting": 2,
                "section_id": 1,
                "show_online": 0,
                "is_online_mandatory": 0,
                "show_offline": 0,
                "is_offline_mandatory": 0,
                "is_active": 1,
                "display_index": 400,
                "extraInfo": []
            },
            {
                "field_id": 12300,
                "organization_id": 212,
                "field_display_name": "Student Source",
                "field_help_text": "",
                "field_type": 3,
                "default_value": "",
                "possible_values": "[{\"name\":\"bb\",\"value\":2,\"status\":1},{\"name\":\"cc\",\"value\":3,\"status\":1},{\"name\":\"dd\",\"value\":4,\"status\":1}]",
                "field_name": "student_source",
                "original_form_type": 1,
                "field_value": "",
                "form_field_mapper_id": 25256,
                "form_type": 1,
                "system_field_setting": 2,
                "section_id": 1,
                "show_online": 0,
                "is_online_mandatory": 0,
                "show_offline": 0,
                "is_offline_mandatory": 0,
                "is_active": 1,
                "display_index": 406
            },
            {
                "field_id": 12302,
                "organization_id": 212,
                "field_display_name": "Standard",
                "field_help_text": "",
                "field_type": 1,
                "default_value": "",
                "possible_values": "[]",
                "field_name": "standard",
                "original_form_type": 1,
                "field_value": 0,
                "form_field_mapper_id": 25258,
                "form_type": 1,
                "system_field_setting": 2,
                "section_id": 1,
                "show_online": 0,
                "is_online_mandatory": 0,
                "show_offline": 0,
                "is_offline_mandatory": 0,
                "is_active": 1,
                "display_index": 408,
                "extraInfo": []
            },
            {
                "field_id": 12313,
                "organization_id": 212,
                "field_display_name": "Residential Address",
                "field_help_text": "",
                "field_type": 1,
                "default_value": "",
                "possible_values": "[]",
                "field_name": "residential_address",
                "original_form_type": 1,
                "field_value": "",
                "form_field_mapper_id": 25240,
                "form_type": 1,
                "system_field_setting": 2,
                "section_id": 1,
                "show_online": 0,
                "is_online_mandatory": 0,
                "show_offline": 0,
                "is_offline_mandatory": 0,
                "is_active": 1,
                "display_index": 411,
                "extraInfo": []
            },
            {
                "field_id": 12312,
                "organization_id": 212,
                "field_display_name": "Landline No.",
                "field_help_text": "",
                "field_type": 2,
                "default_value": "",
                "possible_values": "[]",
                "field_name": "landline_no",
                "original_form_type": 1,
                "field_value": "",
                "form_field_mapper_id": 25239,
                "form_type": 1,
                "system_field_setting": 2,
                "section_id": 1,
                "show_online": 0,
                "is_online_mandatory": 0,
                "show_offline": 0,
                "is_offline_mandatory": 0,
                "is_active": 1,
                "display_index": 412,
                "extraInfo": []
            },
            {
                "field_id": 12311,
                "organization_id": 212,
                "field_display_name": "Alternate Email",
                "field_help_text": "",
                "field_type": 1,
                "default_value": "",
                "possible_values": "[]",
                "field_name": "alternate_email",
                "original_form_type": 1,
                "field_value": "",
                "form_field_mapper_id": 25238,
                "form_type": 1,
                "system_field_setting": 2,
                "section_id": 1,
                "show_online": 0,
                "is_online_mandatory": 0,
                "show_offline": 0,
                "is_offline_mandatory": 0,
                "is_active": 1,
                "display_index": 413,
                "extraInfo": []
            },
            {
                "field_id": 12299,
                "organization_id": 212,
                "field_display_name": "Pincode",
                "field_help_text": "",
                "field_type": 2,
                "default_value": "",
                "possible_values": "",
                "field_name": "pincode",
                "original_form_type": 1,
                "field_value": "",
                "form_field_mapper_id": 25255,
                "form_type": 1,
                "system_field_setting": 2,
                "section_id": 1,
                "show_online": 0,
                "is_online_mandatory": 0,
                "show_offline": 0,
                "is_offline_mandatory": 0,
                "is_active": 1,
                "display_index": 519,
                "extraInfo": []
            },
            {
                "field_id": 12297,
                "organization_id": 212,
                "field_display_name": "City",
                "field_help_text": "",
                "field_type": 1,
                "default_value": "",
                "possible_values": "",
                "field_name": "city",
                "original_form_type": 1,
                "field_value": "",
                "form_field_mapper_id": 25253,
                "form_type": 1,
                "system_field_setting": 2,
                "section_id": 1,
                "show_online": 0,
                "is_online_mandatory": 0,
                "show_offline": 0,
                "is_offline_mandatory": 0,
                "is_active": 1,
                "display_index": 521,
                "extraInfo": []
            },
            {
                "field_id": 12317,
                "organization_id": 212,
                "field_display_name": "Aadhar Number",
                "field_help_text": "",
                "field_type": 1,
                "default_value": "",
                "possible_values": "",
                "field_name": "aadhaar_number",
                "original_form_type": 1,
                "field_value": "",
                "form_field_mapper_id": 25244,
                "form_type": 1,
                "system_field_setting": 2,
                "section_id": 1,
                "show_online": 0,
                "is_online_mandatory": 0,
                "show_offline": 0,
                "is_offline_mandatory": 0,
                "is_active": 1,
                "display_index": 522,
                "extraInfo": []
            },
            {
                "field_id": 12308,
                "organization_id": 212,
                "field_display_name": "Parent Email",
                "field_help_text": "",
                "field_type": 1,
                "default_value": "",
                "possible_values": "",
                "field_name": "parent_email",
                "original_form_type": 1,
                "field_value": "",
                "form_field_mapper_id": 25235,
                "form_type": 1,
                "system_field_setting": 2,
                "section_id": 1,
                "show_online": 0,
                "is_online_mandatory": 0,
                "show_offline": 0,
                "is_offline_mandatory": 0,
                "is_active": 1,
                "display_index": 524,
                "extraInfo": []
            },
            {
                "field_id": 12316,
                "organization_id": 212,
                "field_display_name": "Qualification_temp",
                "field_help_text": "",
                "field_type": 3,
                "default_value": "",
                "possible_values": "[{\"name\":\"working\",\"status\":1,\"value\":1},{\"name\":\"not working\",\"status\":1,\"value\":2},{\"name\":\"hhhh\",\"status\":1,\"value\":3}]",
                "field_name": "qualification",
                "original_form_type": 1,
                "field_value": "0",
                "form_field_mapper_id": 25243,
                "form_type": 1,
                "system_field_setting": 2,
                "section_id": 1,
                "show_online": 0,
                "is_online_mandatory": 0,
                "show_offline": 0,
                "is_offline_mandatory": 0,
                "is_active": 1,
                "display_index": 525,
                "extraInfo": []
            },
            {
                "field_id": 12303,
                "organization_id": 212,
                "field_display_name": "Occupation",
                "field_help_text": "Enter Occupation",
                "field_type": 3,
                "default_value": "",
                "possible_values": "[{\"name\":\"Option 1\",\"sta

Access: Any logged-in user, for their own profile.

Query parameters
Organization whose profile form to use. Defaults to the institute's online organization. Ignored when you call from a branch-specific domain, which always uses that branch.

Response: user has three lists:

  • system_fields: built-in fields (name, email, phone, address, guardian and so on). Each has field_id, organization_id, field_name (e.g. student_name, student_email, student_mobile_number), field_display_name, field_help_text, field_type (1 text, 2 number, 3 dropdown, 4 date, 5 file upload), possible_values, default_value, field_value (the user's current value), show_online/is_online_mandatory, show_offline/is_offline_mandatory, is_active, section_id, display_index and extraInfo (for phone fields: country_id and dail_code).
  • custom_fields: the organization's custom fields, same shape. File fields return a download link in field_value.
  • document_name: documents the user has uploaded (file_key, file_id, file_url, file_size).

Notes: Fields are ordered by display_index. Rate limit: 30 requests per minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI