Get Form Fields

The Get Form Fields API allows you to retrieve all fields defined in a specific form. This endpoint returns detailed information about each field including its unique identifier, full qualified name, type, display name, and organizational context within the form structure.

API Endpoint

GET {base_url}/ExtForm/forms/{formId}/fields

Path Parameters

Parameter	Type	Required	Description
formId	string	Yes	Unique identifier of the form for which to retrieve fields

Request Headers

Authorization: Bearer {your_access_token}

Response

The response contains a list of all fields in the specified form, including their identifiers, types, and organizational structure.

Response Structure

{
  "statusCode": 200,
  "messages": [
    "Processed successfully"
  ],
  "result": {
    "count": 50,
    "fields": [
      {
        "fieldId": "3c2403cd-7067-4c08-821b-9fb2e5751c4f",
        "fqName": "Page_Section_FieldName",
        "fieldType": "DatePicker",
        "fieldName": "Date of Birth",
        "sectionName": "Personal Information",
        "pageName": "Customer Details",
        "isRequired": true
      },
      // ... more fields
    ]
  }
}

Response Fields

Field	Type	Description
count	integer	Total number of fields in the form
fields	array	List of field objects

Field Object Properties

Property	Type	Description
fieldId	string	Unique identifier of the field
fqName	string	Fully qualified name in format "PageName_SectionName_FieldName"
fieldType	string	Field type from FieldTypeEnum (e.g., "Text", "DatePicker", "MultiOptionsCheckBox")
fieldName	string	Display name of the field
sectionName	string	Name of the section containing the field
pageName	string	Name of the page containing the field
isRequired	boolean	Indicates whether the field is required or not

Example Usage

Request

GET {base_url}/ExtForm/forms/f4e72dba-7b5c-8g7h-9i8j-12k34l56m78n/fields
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Response

{
  "statusCode": 200,
  "messages": [
    "Processed successfully"
  ],
  "result": {
    "count": 3,
    "fields": [
      {
        "fieldId": "3c2403cd-7067-4c08-821b-9fb2e5751c4f",
        "fqName": "PersonalInfo_Details_DateOfBirth",
        "fieldType": "DatePicker",
        "fieldName": "Date of Birth",
        "sectionName": "Details",
        "pageName": "PersonalInfo",
        "isRequired": true
      },
      {
        "fieldId": "5d10fd74-658b-41d5-8fed-2d60d52a89c0",
        "fqName": "PersonalInfo_Details_Address",
        "fieldType": "UserAddress",
        "fieldName": "Address Details",
        "sectionName": "Details",
        "pageName": "PersonalInfo",
        "isRequired": false
      },
      {
        "fieldId": "308fec76-b67f-45ec-81e2-06cff19b7c35",
        "fqName": "PersonalInfo_Identity_Passport",
        "fieldType": "Passport",
        "fieldName": "Passport",
        "sectionName": "Identity",
        "pageName": "PersonalInfo",
        "isRequired": true
      }
    ]
  }
}

Notes

• Use either the field id (fieldId) or the fully qualified name (fqName) when submitting answers through the Save Submission API
• Fields are grouped by pages and sections to reflect the form's hierarchical structure
• Field types determine the answer model required when submitting form responses
• Some fields may have additional validation rules not exposed through this API

Related Resources

• Get Forms API - Retrieve available forms
• Save Submission API - Submit answers for a form
• Documents Upload API - Upload documents referenced in form answers
• Lookup API - Retrieve reference data for dropdown fields and other lookups

Error Handling

Status Code	Description	Solution
400	Invalid formId format	Check the format of your formId parameter
403	Insufficient permissions	Verify your authentication token and permissions
404	Form not found	Confirm the form exists and the formId is correct
500	Server error	Contact support if the error persists