Get Signup Custom Fields
Returns the extra fields shown on your learner signup form, so a custom signup page can show the same fields and send them to "Signup User" as `custom_fields`.
GET
/public/signupfieldsGet Signup Custom Fields
curl --request GET \
--url 'https://<your-api-host>/nuSource/api/v1/public/signupfields?form_type=1'{
"code": 200,
"message": "Success",
"is_contact_number_mandatory": 1,
"custom_fields": [
{
"display_index": 37,
"field_display_name": "Text | online Pre",
"field_help_text": "",
"field_id": 234163,
"field_name": "text_|_online_pre",
"field_type": 1,
"system_field_setting": 0,
"form_type": 1,
"is_active": 1,
"is_offline_mandatory": 0,
"is_online_mandatory": 1,
"possible_values": "[]",
"section_id": 1,
"show_offline": 0,
"show_online": 1
},
{
"display_index": 48,
"field_display_name": "Text | Post man",
"field_help_text": "",
"field_id": 234162,
"field_name": "text_|_post_man",
"field_type": 1,
"system_field_setting": 0,
"form_type": 1,
"is_active": 1,
"is_offline_mandatory": 0,
"is_online_mandatory": 1,
"possible_values": "[]",
"section_id": 1,
"show_offline": 0,
"show_online": 1
},
{
"display_index": 92,
"field_display_name": "Occupation t",
"field_help_text": "",
"field_id": 214629,
"field_name": "occupation_t",
"field_type": 1,
"system_field_setting": 0,
"form_type": 1,
"is_active": 1,
"is_offline_mandatory": 0,
"is_online_mandatory": 1,
"possible_values": "[]",
"section_id": 1,
"show_offline": 0,
"show_online": 1
},
{
"display_index": 128,
"field_display_name": "City",
"field_help_text": "",
"field_id": 17277,
"field_name": "city",
"field_type": 1,
"system_field_setting": 2,
"form_type": 1,
"is_active": 1,
"is_offline_mandatory": 0,
"is_online_mandatory": 1,
"possible_values": "[]",
"section_id": 1,
"show_offline": 0,
"show_online": 1
},
{
"display_index": 131,
"field_display_name": "Parent Name",
"field_help_text": "",
"field_id": 17286,
"field_name": "parent_name",
"field_type": 1,
"system_field_setting": 2,
"form_type": 1,
"is_active": 1,
"is_offline_mandatory": 0,
"is_online_mandatory": 1,
"possible_values": "[]",
"section_id": 1,
"show_offline": 0,
"show_online": 1
},
{
"display_index": 135,
"field_display_name": "Parent Email",
"field_help_text": "",
"field_id": 17288,
"field_name": "parent_email",
"field_type": 1,
"system_field_setting": 2,
"form_type": 1,
"is_active": 1,
"is_offline_mandatory": 0,
"is_online_mandatory": 1,
"possible_values": "[]",
"section_id": 1,
"show_offline": 0,
"show_online": 1
}
]
}Access: Public, no API key needed.
Query parameters
is_online_orginteger
1 (default) reads the online organization's form. 0 reads the organization in your ORGID header (needs a key).Response
codeinteger
Example:
200messagestring
Example:
Successis_contact_number_mandatoryinteger
Example:
1custom_fieldsobject[]
Active fields shown online, in display order, each
Show child attributesHide child attributes
custom_fields.display_indexinteger
Example:
37Example:
Text | online Precustom_fields.field_idinteger
Example:
234163custom_fields.field_namestring
Example:
text_|_online_precustom_fields.field_typeinteger
Example:
1Example:
0custom_fields.form_typeinteger
Example:
1custom_fields.is_activeinteger
Example:
1Example:
0Example:
1custom_fields.section_idinteger
Example:
1custom_fields.show_offlineinteger
Example:
0custom_fields.show_onlineinteger
Example:
1Notes: The institute is worked out from the website host you call; a custom branch domain uses that branch's form. Mobile number, email, username, name, state and source are not listed as fields. Rate limit: 30 requests per 1 minute; going over locks you out for 30 minutes.