Docs home

List Fields

Lists the fields (system and custom) on one of an organization's forms: the learner signup form, the enquiry form or the tutor form. Use it to know which fields to send, and their IDs, when you create learners or enquiries.

GET/organization/fields
List Fields
curl --request GET \
  --url 'https://<your-api-host>/nuSource/api/v1/organization/fields?organization_id=<organizationId>&form_type=1&filter_param=0' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>'
{
    "code": 200,
    "message": "Success",
    "custom_fields": [
        {
            "field_id": 27478,
            "organization_id": 212,
            "field_display_name": "custom file",
            "field_help_text": "",
            "field_type": 5,
            "default_value": "",
            "possible_values": "[]",
            "field_name": "custom_file",
            "original_form_type": 1,
            "form_field_mapper_id": 39839,
            "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": 104
        },
        {
            "field_id": 58331,
            "organization_id": 212,
            "field_display_name": "Custom text Field",
            "field_help_text": "",
            "field_type": 1,
            "default_value": "",
            "possible_values": "[]",
            "field_name": "custom_text_field",
            "original_form_type": 1,
            "form_field_mapper_id": 71349,
            "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": 141
        },
        {
            "field_id": 164701,
            "organization_id": 212,
            "field_display_name": "Discription",
            "field_help_text": "",
            "field_type": 1,
            "default_value": "",
            "possible_values": "[]",
            "field_name": "discription",
            "original_form_type": 1,
            "form_field_mapper_id": 176360,
            "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": 142
        },
        {
            "field_id": 233825,
            "organization_id": 212,
            "field_display_name": "Driving Licence No.",
            "field_help_text": "driving",
            "field_type": 1,
            "default_value": "",
            "possible_values": "[]",
            "field_name": "driving_licence_no.",
            "original_form_type": 1,
            "form_field_mapper_id": 244322,
            "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": 147
        },
        {
            "field_id": 233826,
            "organization_id": 212,
            "field_display_name": "Age",
            "field_help_text": "age",
            "field_type": 2,
            "default_value": "",
            "possible_values": "[]",
            "field_name": "age",
            "original_form_type": 1,
            "form_field_mapper_id": 244323,
            "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": 148
        },
        {
            "field_id": 237334,
            "organization_id": 212,
            "field_display_name": "Age Online",
            "field_help_text": "",
            "field_type": 2,
            "default_value": "",
            "possible_values": "[]",
            "field_name": "age_online",
            "original_form_type": 1,
            "form_field_mapper_id": 247823,
            "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": 149
        },
        {
            "field_id": 47311,
            "organization_id": 212,
            "field_display_name": "custom text",
            "field_help_text": "",
            "field_type": 1,
            "default_value": "",
            "possible_values": "[]",
            "field_name": "custom_text",
            "original_form_type": 1,
            "form_field_mapper_id": 59339,
            "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": 150
        },
        {
            "field_id": 148456,
            "organization_id": 212,
            "field_display_name": "Test Raviii",
            "field_help_text": "",
            "field_type": 4,
            "default_value": "",
            "possible_values": "[]",
            "field_name": "test_raviii",
            "original_form_type": 1,
            "form_field_mapper_id": 160408,
            "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": 152
        },
        {
            "field_id": 80871,
            "organization_id": 212,
            "field_display_name": "Custom Date New",
            "field_help_text": "",
            "field_type": 4,
            "default_value": "",
            "possible_values": "[]",
            "field_name": "custom_date",
            "original_form_type": 1,
            "form_field_mapper_id": 93593,
            "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": 153
        },
        {
            "field_id": 153578,
            "organization_id": 212,
            "field_display_name": "Employee id",
            "field_help_text": "",
            "field_type": 1,
            "default_value": "",
            "possible_values": "[]",
            "field_name": "employee_id",
            "original_form_type": 1,
            "form_field_mapper_id": 165438,
            "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": 154
        },
        {
            "field_id": 169348,
            "organization_id": 212,
            "field_display_name": "Gender..",
            "field_help_text": "Gender",
            "field_type": 3,
            "default_value": "",
            "possible_values": "[{\"name\":\"Male\",\"value\":1,\"status\":1},{\"name\":\"Female\",\"value\":2,\"status\":1},{\"name\":\"Not required\",\"value\":3,\"status\":1}]",
            "field_name": "gender..",
            "original_form_type": 2,
            "form_field_mapper_id": 180945,
            "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": 162
        },
        {
            "field_id": 6267,
            "organization_id": 212,
            "field_display_name": "Name123",
            "field_help_text": "",
            "field_type": 2,
            "default_value": "",
            "possible_values": "[]",
            "field_name": "name1",
            "original_form_type": 2,
            "form_field_mapper_id": 8218,
            "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": 163
        },
        {
            "field_id": 34653,
            "organization_id": 212,
            "field_display_name": "Marksheet",
            "field_help_text": "All marksheets",
            "field_type": 5,
            "default_value": "",
            "possible_values": "[]",
            "field_name": "marksheet",
            "original_form_type": 1,
            "form_field_mapper_id": 46801,
            "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": 164
        },
        {
            "field_id": 58332,
            "organization_id": 212,
            "field_display_name": "Custom Number",
            "field_help_text": "",
            "field_type": 2,
            "default_value": "",
            "possible_values": "[]",
            "field_name": "custom_number",
            "original_form_type": 1,
            "form_field_mapper_id": 71350,
            "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": 165
        },
        {
            "field_id": 34597,
            "organization_id": 212,
            "field_display_name": "Test Field",
            "field_help_text": "",
            "field_type": 3,
            "default_value": "",
            "possible_values": "[{\"name\":\"Value 1\",\"value\":1,\"status\":1},{\"name\":\"Value 2\",\"value\":2,\"status\":1}]",
            "field_name": "test_field",
            "original_form_type": 1,
            "form_field_mapper_id": 46746,
            "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": 166
        },
        {
            "field_id": 231616,
            "organization_id": 212,
            "field_display_name": "test PM",
            "field_help_text": "MAN",
            "field_type": 1,
            "default_value": "",
            "possible_values": "[]",
            "field_name": "test_pm",
            "original_form_type": 1,
            "form_field_mapper_id": 242097,
            "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": 167
        },
        {
            "field_id": 6247,
            "organization_id": 212,
            "field_display_name": "Custom Field ",
            "field_help_text": "",
            "field_type": 1,
            "default_value": "",
            "possible_values": "[]",
            "field_name": "custom_field_",
            "original_form_type": 2,
            "form_field_mapper_id": 8198,
            "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": 168
        },
        {
            "field_id": 194574,
            "organization_id": 212,
            "field_display_name": "Rank",
            "field_help_text": "",
            "field_type": 1,
            "default_value": "",
            "possible_values": "[]",
            "field_name": "rank",
            "original_form_type": 1,
            "form_field_mapper_id": 205713,
            "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": 170
        },
        {
            "field_id": 231337,
            "organization_id": 212,
            "field_display_name": "ds",
            "field_help_text": "dd",
            "field_type": 1,
            "default_value": "",
            "possible_values": "[]",
            "field_name": "ds",
            "original_form_type": 1,
            "form_field_mapper_id": 241823,
            "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": 188
        },
        {
            "field_id": 243275,
            "organization_id": 212,
            "field_display_name": "Languages Known",
            "field_help_text": "",
            "field_type": 3,
            "default_value": "",
            "possible_values": "[{\"name\":\"Kannada\",\"value\":1,\"status\":1},{\"name\":\"English\",\"value\":2,\"status\":1},{\"name\":\"Hindi\",\"value\":3,\"status\":1}]",
            "field_name": "languages_known",
            "original_form_type": 1,
            "form_field_mapper_id": 253661,
            "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": 190
        },
        {
            "field_id": 212482,
            "organization_id": 212,
            "field_display_name": "Certificate",
            "field_help_text": "",
            "field_type": 5,
            "default_value": "",
            "possible_values": "[]",
            "field_name": "certificate",
            "original_form_type": 1,
            "form_field_mapper_id": 223305,
            "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": 191
        },
        {
            "field_id": 58333,
            "organization_id": 212,
            "field_display_name": "custom Dropdown",
            "field_help_text": "",
            "field_type": 3,
            "default_value": "",
            "possible_values": "[{\"name\":\"Test 1\",\"value\":1,\"status\":1},{\"name\":\"Test 2\",\"value\":2,\"status\":1,\"\":0},{\"name\":\"Test 3\",\"value\":3,\"status\":1,\"\":0}]",
            "field_name": "custom_dropdown",
            "original_form_type": 1,
            "form_field_mapper_id": 71351,
            "form_type": 1,
            "system_field_setting": 0,
            "section_id": 1,
            "show_online": 1,
            "is_online_mandatory": 0,
            "show_offline": 0,
            "is_offline_mandatory": 0,
            "is_active": 1,
            "display_index": 203
        },
        {
            "field_id": 200589,
            "organization_id": 212,
            "field_display_name": "City  Number One",
            "field_help_text": "",
            "field_type": 1,
            "default_value": "",
            "possible_values": "[]",
            "field_name": "city_2_",
            "original_form_type": 1,
            "form_field_mapper_id": 211625,
            "form_type": 1,
            "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": 224
        },
        {
            "field_id": 321485,
            "organization_id": 212,
            "field_display_name": "test test",
            "field_help_text": "",
            "field_type": 1,
            "default_value": "",
            "possible_values": "[]",
            "field_name": "test_test",
            "original_form_type": 1,
            "form_field_mapper_id": 331192,
            "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": 254
        },
        {
            "field_id": 321487,
            "organization_id": 212,
            "field_display_name": "Bocw Id",
            "field_help_text": "",
            "field_type": 2,
            "default_value": "",
            "possible_values": "[]",
            "field_name": "bocw_id",
            "original_form_type": 2,
            "form_field_mapper_id": 331195,
            "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": 255
        },
        {
            "field_id": 200755,
            "organization_id": 212,
            "field_display_name": "      City",
            "field_help_text": "",
            "field_type": 1,
            "default_value": "",
            "possible_values": "[]",
            "field_name": "______city",
            "original_form_type": 1,
            "form_field_mapper_id": 211788,
            "form_type": 1,
            "system_field_setting": 0,
            "section_id": 1,
            "show_online": 1,
            "is_online_mandatory": 2,
            "show_offline": 1,
            "is_offline_mandatory": 0,
            "is_active": 1,
            "display_index": 280
        },
        {
            "field_id": 248536,
            "organization_id": 212,
            "field_display_name": "bugTest",
            "field_help_text": "",
            "field_type": 3,
            "default_value": "",
            "possible_values": "[{\"name\":\"tree\",\"value\":1,\"status\":1}]",
            "field_name": "bugtest",
            "original_form_type": 2,
            "form_field_mapper_id": 258829,
            "form_type": 1,
            "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": 281
        },
        {
            "field_id": 94744,
            "organization_id": 212,
            "field_display_name": "test",
            "field_help_text": "acas",
            "field_type": 1,
            "default_value": "",
            "possible_values": "[]",
            "field_name": "test",
            "original_form_type": 1,
            "form_field_mapper_id": 107322,
            "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": 285
        },
        {
            "field_id": 149117,
            "organization_id": 212,
            "field_display_na

Access: Institute admins, plus custom roles that can view field customization or custom fields, or create admissions.

Query parameters
organization_idintegerrequired
Organization whose form to read.
form_typeintegerrequired
1 learner signup, 2 enquiry, 3 tutor.
0 all fields (default), 1 only fields shown on the online form, 2 only fields shown on the admin (offline) form.
1 returns only fields required on the admin (offline) form.
1 also adds your institute's batch custom fields (marked batch_fields: 1).

Response: custom_fields is an array, ordered by field kind, section and display order. Each field has field_id, organization_id, field_name (internal name), field_display_name, field_help_text, field_type: 1 Text, 2 Number, 3 Dropdown, 4 Date, 5 File upload, default_value, possible_values (a JSON string; for dropdowns a list of name, value and status), form_type, original_form_type, form_field_mapper_id, system_field_setting: 0 custom field, 1 required system field, 2 optional system field, section_id, show_online/is_online_mandatory (shown / required on the online signup form), show_offline/is_offline_mandatory (shown / required when an admin adds the learner), is_active and display_index.

Notes: Rate limit: 100 requests per 1 minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI