Get Field Details
Returns one form field's settings, for example the options of a dropdown field.
GET
/organization/fields/{fieldId}Get Field Details
curl --request GET \
--url 'https://<your-api-host>/nuSource/api/v1/organization/fields/{fieldId}?form_type=1' \
--header 'APIKEY: <your-api-key>' \
--header 'ORGID: <your-org-id>'{
"code": 200,
"message": "Success",
"custom_fields": {
"field_id": 142106,
"organization_id": 212,
"field_display_name": "Language",
"field_help_text": "",
"field_type": 3,
"default_value": "",
"possible_values": "[{\"name\":\"Eng\",\"value\":1,\"status\":1},{\"name\":\"Kan\",\"value\":2,\"status\":0},{\"name\":\"Hindi\",\"value\":3,\"status\":1}]",
"field_name": "language",
"original_form_type": 1,
"form_field_mapper_id": 154153,
"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": 314
}
}Access: Institute admins, plus custom roles that can view field customization or create admissions.
Path parameters
Field ID (
field_id from "List Fields").Query parameters
Form the field is on:
1 learner signup, 2 enquiry, 3 tutor.Response
codeinteger
Example:
200messagestring
Example:
Successcustom_fieldsobject
Show child attributesHide child attributes
custom_fields.field_idinteger
Example:
142106Example:
212Example:
Languagecustom_fields.field_typeinteger
Example:
3A JSON string; for dropdowns a list of
name, value and statusExample:
1Example:
154153custom_fields.form_typeinteger
Example:
1Example:
0custom_fields.section_idinteger
Example:
1custom_fields.show_onlineinteger
Example:
0custom_fields.show_offlineinteger
Example:
0custom_fields.is_activeinteger
Example:
1custom_fields.display_indexinteger
Example:
314Notes: custom_fields is null if the field is not on that form. Rate limit: 100 requests per 1 minute; going over locks you out for 30 minutes.