Skip to content

Every form returned by the API includes a questions array. Each item is a question object with a questionType that determines which type-specific settings object is present.

Use this section to understand the structure of each field type. Examples are taken from real API responses.

Common properties

All question objects share a set of top-level fields, regardless of type.

FieldTypeDescription
_idstringUnique question identifier (use this when matching submission answers)
questionTypestringField type (for example, email, choice, text)
questionstringQuestion title shown to respondents
displayOrdernumberZero-based position in the form
isRequiredbooleanWhether the field must be answered before submission
isDeletedbooleanSoft-deleted questions remain in the array but are hidden
isActivebooleanWhether the question is currently visible on the form
placeholderstringPlaceholder text (supported on some types)
descriptionstringHelper text shown below the question title
mediaobjectOptional image or video attached to the question
productbasketobjectPayment-related settings when the form accepts payments

Type-specific settings live in a nested object named after the field type (for example, email, choice, text).

{
  "_id": "6a0ef5da3affac35058b05a6",
  "questionType": "email",
  "question": "Enter your email address",
  "placeholder": "Enter Email",
  "displayOrder": 1,
  "isRequired": false,
  "isDeleted": false,
  "isActive": true,
  "description": "Short text Helper text",
  "email": {
    "labels": { "confirmation": "Confirm email" },
    "isShowConfirmation": true,
    "isLimitedDomain": true,
    "limitedDomain": "forms.app"
  },
  "productbasket": {
    "tax": { "type": "includes" }
  }
}

Field types

The questionType value tells you which nested object to read:

questionTypeNested objectGuide
fullnamefullnameFull name
emailemailEmail
phonephonePhone
addressaddressAddress
texttextText (short, long, or masked)
numbernumberNumber
datedateDate & time
time-Date & time
choicechoiceSelection fields (see sub-pages below)
selectionmatrixselectionmatrixSelection matrix
imageuploadimageUploadImage upload
fileuploadfileUploadFile upload
drawingdrawingDrawing & signature
termsandconditionstermsandconditionsTerms & conditions
imagecontentmediaImage content
seperator-Separator
wysiwygwysiwygExplanation
timer-Timer

For choice fields, the actual input style is determined by choice.subType: singlechoice, multiplechoice, yesno, dropdown, picturechoice, opinionscale, rating, or ranking.

What's next?