Get Form Fields

The endpoint provides a method to retrieve the list of forms fields for the perticular form_type provided by the authenticated client. The requests are HTTP GET (RFC2616) and uses api key as a resource identifier identifying the client uniquely at HB.

If there’s no forms assigned to your account, the API should send an HTTP 204 No Content response.

This endpoint can return a JSON response with the following data:

count: the total number of fields in this form

fields: a JSON body of fields which can contain the following data:

field_id: This is the field ID, indicating the unique ID of that field.

field_type: This is the field type, such as text, date, radio, checkbox, etc.

field_name: This indicates the unique field name which the user needs to pass as form_data with a POST request for creating a new submission.

field_label: This indicates the label of this field.

validations: This is provided for your reference; you can validate the data on your side before posting it to the HB API.

maxlength: The maximum number of characters allowed for this field.

options: If your field type is radio, checkbox, or selectbox, you can find the options here in serialized format.

sort_order: The sort order of this field (in ascending order).

required: A boolean value indicating if the field is required or not.

field_group: The group name to which this field belongs.

fieldset: The label of that group name.

Responses

⚪0Get Form Fields

application/json

Bodyapplication/json

Example

{
    "count": 1,
    "fields": [
        {
            "field_id": "XX",
            "field_type": "text",
            "field_name": "first_name",
            "field_lable": "First Name",
            "validations": "alpha_text|max_length[40]",
            "maxlength": 120,
            "options": "",
            "sort_order": 1,
            "required": 1,
            "field_group": "name",
            "fieldset": "Personal information"
        }
    ]
}

Request

Request Code Samples

Responses