Fetching Form Details

Fetches detailed information for a specific form (form_id).

[GET] https://api.moaform.com/v1/forms/{form_id}

 

REQUEST

Path Parameters

KeyDescription
form_idRequired, Unique ID of the form

 

RESPONSE

KeyTypeDescription
long_idstringUnique ID of the form
idstringlong_id is the official form ID. For compatibility with older versions, id is temporarily supported but will no longer be available in the future, please use long_id whenever possible.
namestringFile name of the form
statusstringForm status (one of editing, pending, collecting, closed)
pages[object] 
↳ idstringUnique ID of the page
↳ numberintegerPage number
↳ visiblebooleanPage visibility
↳ blocks_countintegerNumber of blocks included
blocks[object](Described in a separate table below. Replace the ... position for each blocks)
.........
welcome_pageobject 
↳ contentstringWelcome page content
thankyou_pages[object] 
↳ idstringUnique ID of Thank you page
↳ contentstringThank you page content
variables[object] 
↳ idstringUnique ID of the defined variable
↳ namestringName of the defined variable
↳ formulastringFormula of the defined variable
ownedboolean 
created_atstringForm creation timestamp
last_updated_atstringLast form modification timestamp
published_atstringLast form publication timestamp

 

blocks details (replace '...' location under blocks on the tale above)

Information

KEYTypeDescription
↳ idstringUnique ID of the block
↳ typestringinformation
↳ indexstringBlock numbering format in the form of P1B1
↳ contentstringInformation content
↳ ribbon_textstringInformation title
↳ propertiesobject 
     ↳ visiblebooleanVisibility of the block
↳ page_idstringUnique ID of the page

 

Line Shape

KEYTypeDescription
↳ idstringUnique ID of the block
↳ typestringline_shape
↳ indexstringBlock numbering format in the form of P1B1
↳ propertiesobject 
     ↳ visiblebooleanVisibility of the block
     ↳ shapestringLine shape (zigzag...)
↳ page_idstringUnique ID of the page

 

Single Choice

KEYTypeDescription
↳ idstringUnique ID of the block
↳ typestringsingle_choice
↳ indexstringBlock numbering format in the form of P1B1
↳ contentstringContent of the question
↳ propertiesobject 
     ↳ visiblebooleanVisibility of the block
     ↳ hide_resultbooleanHiding result indicator
     ↳ allow_other_choicebooleanAllow 'Other' option
     ↳ randomizebooleanRandomization of choices order
     ↳ assign_scorebooleanScore assignment
     ↳ choices[object] 
          ↳ idstringUnique ID of the choice
          ↳ indexstringChoice numbering format in the form of P1B1C1
          ↳ labelstringContent of the choice
          ↳ scoreintegerScore assigned to the choice
          ↳ visiblebooleanVisibility of the choice
          ↳ is_otherbooleanIs 'Other' option (only with allow_other_choice=true)
↳ validationsobject 
     ↳ requiredbooleanResponse required indicator for the block
     ↳ required_otherbooleanComments required indicator for 'Other' choice (only with allow_other_choice=true)
↳ page_idstringUnique ID of the page

 

Dropdown

KEYTypeDescription
↳ idstringUnique ID of the block
↳ typestringdropdown
↳ indexstringBlock numbering format in the form of P1B1
↳ contentstringContent of the question
↳ propertiesobject 
     ↳ visiblebooleanVisibility of the block
     ↳ hide_resultbooleanHiding result indicator
     ↳ allow_other_choicebooleanAllow 'Other' option
     ↳ randomizebooleanRandomization of choices order
     ↳ assign_scorebooleanScore assignment
     ↳ choices[object] 
          ↳ idstringUnique ID of the choice
          ↳ indexstringChoice numbering format in the form of P1B1C1
          ↳ labelstringContent of the choice
          ↳ scoreintegerScore assigned to the choice
          ↳ visiblebooleanVisibility of the choice
          ↳ is_otherbooleanIs 'Other' option (only with allow_other_choice=true)
↳ validationsobject 
     ↳ requiredbooleanResponse required indicator for the block
     ↳ required_otherbooleanComments required indicator for 'Other' choice (only with allow_other_choice=true)
↳ page_idstringUnique ID of the page

 

Multiple Choice

KEYTypeDescription
↳ idstringUnique ID of the block
↳ typestringmultiple_choice
↳ indexstringBlock numbering format in the form of P1B1
↳ contentstringContent of the question
↳ propertiesobject 
     ↳ visiblebooleanVisibility of the block
     ↳ hide_resultbooleanHiding result indicator
     ↳ allow_other_choicebooleanAllow 'Other' option
     ↳ randomizebooleanRandomization of choices order
     ↳ assign_scorebooleanScore assignment
     ↳ choices[object] 
          ↳ idstringUnique ID of the choice
          ↳ indexstringChoice numbering format in the form of P1B1C1
          ↳ labelstringContent of the choice
          ↳ scoreintegerScore assigned to the choice
          ↳ visiblebooleanVisibility of the choice
          ↳ is_otherbooleanIs 'Other' option (only with allow_other_choice=true)
↳ validationsobject 
     ↳ requiredbooleanResponse required indicator for the block
     ↳ required_otherbooleanComments required indicator for 'Other' choice  (only with allow_other_choice=true)
     ↳ min_selectionintegerMinimum number of choices can be selected
     ↳ max_selectionintegerMaximum number of choices can be selected
↳ page_idstringUnique ID of the page

 

Ranking

KEYTypeDescription
↳ idstringUnique ID of the block
↳ typestringranking
↳ indexstringBlock numbering format in the form of P1B1
↳ contentstringContent of the question
↳ properties[object] 
     ↳ visiblebooleanVisibility of the block
     ↳ hide_resultbooleanHiding result indicator
     ↳ allow_other_choicebooleanAllow 'Other' option
     ↳ randomizebooleanRandomization of choices order
     ↳ choices[object] 
          ↳ idstringUnique ID of the choice
          ↳ indexstringChoice numbering format in the form of P1B1C1
          ↳ labelstringContent of the choice
          ↳ visiblebooleanVisibility of the choice
          ↳ is_otherbooleanIs 'Other' option (only with allow_other_choice=true)
↳ validationsobject 
     ↳ requiredbooleanResponse required indicator for the block
     ↳ required_otherbooleanComments required indicator for 'Other' choice (only with allow_other_choice=true)
     ↳ min_selectionintegerMinimum number of choices can be selected
     ↳ max_selectionintegerMaximum number of choices can be selected
↳ page_idstringUnique ID of the page

 

Matrix Single Choice

KEYTypeDescription
↳ idstringUnique ID of the block
↳ typestringmatrix_single_choice
↳ indexstringBlock numbering format in the form of P1B1
↳ contentstringContent of the question
↳ propertiesobject 
     ↳ visiblebooleanVisibility of the block
     ↳ hide_resultbooleanHiding result indicator
     ↳ assign_scorebooleanScore assignment
↳ blocks[object] 
     ↳ idstringUnique ID of the sub-question
     ↳ indexstringSub-question numbering format in the form of P1B1.1
     ↳ contentstringContent of the sub-question
     ↳ visiblebooleanVisibility of the sub-question
     ↳ propertiesobject 
          ↳ choices[object] 
               ↳ idstringUnique ID of the choice
               ↳ indexstringChoice numbering format in the form of P1B1.1C1
               ↳ labelstringContent of the choice
               ↳ scoreintegerScore assigned to the choice
               ↳ visiblebooleanVisibility of the choice
↳ validationsobject 
     ↳ requiredbooleanResponse required indicator for the block
↳ page_idstringUnique ID of the page

 

Matrix Multiple Choice

KEYTypeDescription
↳ idstringUnique ID of the block
↳ typestringmatrix_multiple_choice
↳ indexstringBlock numbering format in the form of P1B1
↳ contentstringContent of the question
↳ propertiesobject 
     ↳ visiblebooleanVisibility of the block
     ↳ hide_resultbooleanHiding result indicator
     ↳ assign_scorebooleanScore assignment
↳ blocks[object] 
     ↳ idstringUnique ID of the sub-question
     ↳ indexstringSub-question numbering format in the form of P1B1.1
     ↳ contentstringContent of the sub-question
     ↳ visiblebooleanVisibility of the sub-question
     ↳ propertiesobject 
          ↳ choices[object] 
               ↳ idstringUnique ID of the choice
               ↳ indexstringChoice numbering format in the form of P1B1.1C1
               ↳ labelstringContent of the choice
               ↳ scoreintegerScore assigned to the choice
               ↳ visiblebooleanVisibility of the choice
↳ validationsobject 
     ↳ requiredbooleanResponse required indicator for the block
     ↳ min_selectionintegerMinimum number of choices can be selected
     ↳ max_selectionintegerMaximum number of choices can be selected
↳ page_idstringUnique ID of the page

 

Matrix Ranking

KEYTypeDescription
↳ idstringUnique ID of the block
↳ typestringmatrix_ranking
↳ indexstringBlock numbering format in the form of P1B1
↳ contentstringContent of the question
↳ propertiesobject 
     ↳ visiblebooleanVisibility of the block
     ↳ hide_resultbooleanHiding result indicator
↳ blocks[object] 
     ↳ idstringUnique ID of the sub-question
     ↳ indexstringSub-question numbering format in the form of P1B1.1
     ↳ contentstringContent of the sub-question
     ↳ visiblebooleanVisibility of the sub-question
     ↳ propertiesobject 
          ↳ choices[object] 
               ↳ idstringUnique ID of the choice
               ↳ indexstringChoice numbering format in the form of P1B1.1C1
               ↳ labelstringContent of the choice
               ↳ visiblebooleanVisibility of the choice
↳ validationsobject 
     ↳ requiredbooleanResponse required indicator for the block
     ↳ min_selectionintegerMinimum number of choices can be selected
     ↳ max_selectionintegerMaximum number of choices can be selected
↳ page_idstringUnique ID of the page

 

Media Single Choice

KEYTypeDescription
↳ idstringUnique ID of the block
↳ typestringmedia_single_choice
↳ indexstringBlock numbering format in the form of P1B1
↳ contentstringContent of the question
↳ propertiesobject 
     ↳ visiblebooleanVisibility of the block
     ↳ hide_resultbooleanHiding result indicator
     ↳ allow_other_choicebooleanAllow 'Other' option
     ↳ randomizebooleanRandomization of choices order
     ↳ assign_scorebooleanScore assignment
     ↳ choices[object] 
          ↳ idstringUnique ID of the choice
          ↳ indexstringChoice numbering format in the form of P1B1C1
          ↳ labelstringContent of the choice
          ↳ scoreintegerScore assigned to the choice
          ↳ visiblebooleanVisibility of the choice
          ↳ is_otherbooleanIs 'Other' option (only with allow_other_choice=true)
          ↳ mediaobjectDoes not appear if no image attached or it is 'Other'.
               ↳ typestringMedia type (currently returns only 'image')
               ↳ urlstringMedia URL
               ↳ widthintegerMedia width
               ↳ heightintegerMedia height
     ↳ mediaobject 
          ↳ fillstringMedia fill method in choice
          ↳ sizestringMedia size in choice
↳ validationsobject 
     ↳ requiredbooleanResponse required indicator for the block
     ↳ required_otherbooleanComments required indicator for 'Other' choice (only with allow_other_choice=true)
↳ page_idstringUnique ID of the page

 

Media Multiple Choice

KEYTypeDescription
↳ idstringUnique ID of the block
↳ typestringmedia_multiple_choice
↳ indexstringBlock numbering format in the form of P1B1
↳ contentstringContent of the question
↳ propertiesobject 
     ↳ visiblebooleanVisibility of the block
     ↳ hide_resultbooleanHiding result indicator
     ↳ allow_other_choicebooleanAllow 'Other' option
     ↳ randomizebooleanRandomization of choices order
     ↳ assign_scorebooleanScore assignment
     ↳ choices[object] 
          ↳ idstringUnique ID of the choice
          ↳ indexstringChoice numbering format in the form of P1B1C1
          ↳ labelstringContent of the choice
          ↳ scoreintegerScore assigned to the choice
          ↳ visiblebooleanVisibility of the choice
          ↳ is_otherbooleanIs 'Other' option (only with allow_other_choice=true)
          ↳ mediaobjectDoes not appear if no image attached or it is 'Other'.
               ↳ typestringMedia type (currently returns only 'image')
               ↳ urlstringMedia URL
               ↳ widthintegerMedia width
               ↳ heightintegerMedia height
     ↳ mediaobject 
          ↳ fillstringMedia fill method in choice
          ↳ sizestringMedia size in choice
↳ validationsobject 
     ↳ requiredbooleanResponse required indicator for the block
     ↳ required_otherbooleanComments required indicator for 'Other' choice (only with allow_other_choice=true)
     ↳ min_selectionintegerMinimum number of choices can be selected
     ↳ max_selectionintegerMaximum number of choices can be selected
↳ page_idstringUnique ID of the page

 

Media Ranking

KEYTypeDescription
↳ idstringUnique ID of the block
↳ typestringmedia_ranking
↳ indexstringBlock numbering format in the form of P1B1
↳ contentstringContent of the question
↳ propertiesobject 
     ↳ visiblebooleanVisibility of the block
     ↳ hide_resultbooleanHiding result indicator
     ↳ allow_other_choicebooleanAllow 'Other' option
     ↳ randomizebooleanRandomization of choices order
     ↳ choices[object] 
          ↳ idstringUnique ID of the choice
          ↳ indexstringChoice numbering format in the form of P1B1C1
          ↳ labelstringContent of the choice
          ↳ scoreintegerScore assigned to the choice
          ↳ visiblebooleanVisibility of the choice
          ↳ is_otherbooleanIs 'Other' option (only with allow_other_choice=true)
          ↳ mediaobjectDoes not appear if no image attached or it is 'Other'.
               ↳ typestringMedia type (currently returns only 'image')
               ↳ urlstringMedia URL
               ↳ widthintegerMedia width
               ↳ heightintegerMedia height
     ↳ mediaobject 
          ↳ fillstringMedia fill method in choice
          ↳ sizestringMedia size in choice
↳ validationsobject 
     ↳ requiredbooleanResponse required indicator for the block
     ↳ required_otherbooleanComments required indicator for 'Other' choice (only with allow_other_choice=true)
     ↳ min_selectionintegerMinimum number of choices can be selected
     ↳ max_selectionintegerMaximum number of choices can be selected
↳ page_idstringUnique ID of the page

 

Point Scale

KEYTypeDescription
↳ idstringUnique ID of the block
↳ typestringpoint_scale
↳ indexstringBlock numbering format in the form of P1B1
↳ contentstringContent of the question
↳ propertiesobject 
     ↳ visiblebooleanVisibility of the block
     ↳ hide_resultbooleanHiding result indicator
     ↳ shapebooleanScale shape
     ↳ stepsintegerScale step
     ↳ scales[integer]Scale range (eg: [-5, -4, -3, -2, -1, 0, 1, 2, 3, 4, 5])
     ↳ label[object] 
         ↳ leftstringScale left label
          ↳ centerstringScale center label
          ↳ rightstringScale right label
↳ validationsobject 
     ↳ requiredbooleanResponse required indicator for the block
↳ page_idstringUnique ID of the page

 

NPS

KEYTypeDescription
↳ idstringUnique ID of the block
↳ typestringnps
↳ indexstringBlock numbering format in the form of P1B1
↳ contentstringContent of the question
↳ propertiesobject 
     ↳ visiblebooleanVisibility of the block
     ↳ hide_resultbooleanHiding result indicator
     ↳ shapebooleanScale shape
     ↳ stepsintegerScale step (11 for NPS)
     ↳ scales[integer]Scale range ([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10] or NPS)
↳ validationsobject 
     ↳ requiredbooleanResponse required indicator for the block
↳ page_idstringUnique ID of the page

 

Star Rating

KEYTypeDescription
↳ idstringUnique ID of the block
↳ typestringrating
↳ indexstringBlock numbering format in the form of P1B1
↳ contentstringContent of the question
↳ propertiesobject 
     ↳ visiblebooleanVisibility of the block
     ↳ hide_resultbooleanHiding result indicator
     ↳ shapebooleanRating shape
     ↳ stepsintegerRating step
     ↳ show_step_countbooleanScore visibility
↳ validationsobject 
     ↳ requiredbooleanResponse required indicator for the block
↳ page_idstringUnique ID of the page

 

Long Text Answer (Free)

KEYTypeDescription
↳ idstringUnique ID of the block
↳ typestringlong_text
↳ indexstringBlock numbering format in the form of P1B1
↳ contentstringContent of the question
↳ propertiesobject 
     ↳ visiblebooleanVisibility of the block
     ↳ hide_resultbooleanHiding result indicator
     ↳ encrypted_answerbooleanResponse data encryption
     ↳ formatstringAnswer format (free, regex)
     ↳ guide_phrasestringGuide phrase
     ↳ sizestringInput box size (large, small)
↳ validationsobject 
     ↳ requiredbooleanResponse required indicator for the block
     ↳ min_characterintegerMinimum number of characters required (default 1)
     ↳ max_characterintegerMaximum number of charaters allowed (default null, means unlimited)
↳ page_idstringUnique ID of the page

 

Long Text Answer (Regular expression)

KEYTypeDescription
↳ idstringUnique ID of the block
↳ typestringlong_text
↳ indexstringBlock numbering format in the form of P1B1
↳ contentstringContent of the question
↳ propertiesobject 
     ↳ visiblebooleanVisibility of the block
     ↳ hide_resultbooleanHiding result indicator
     ↳ encrypted_answerbooleanResponse data encryption
     ↳ formatstringAnswer format (free, regex)
     ↳ error_textstringError message
     ↳ guide_phrasestringGuide phrase
     ↳ sizestringInput box size (large, small)
↳ validationsobject 
     ↳ requiredbooleanResponse required indicator for the block
     ↳ conditionstringRegular expression data condition
     ↳ patternstringRegular expression data pattern
↳ page_idstringUnique ID of the page

 

Short Text Answer (Free)

KEYTypeDescription
↳ idstringUnique ID of the block
↳ typestringshort_text
↳ indexstringBlock numbering format in the form of P1B1
↳ contentstringContent of the question
↳ propertiesobject 
     ↳ visiblebooleanVisibility of the block
     ↳ hide_resultbooleanHiding result indicator
     ↳ encrypted_answerbooleanResponse data encryption
     ↳ formatstringAnswer format (free, regex)
     ↳ guide_phrasestringGuide phrase
     ↳ sizestringInput box size (long, medium)
↳ validationsobject 
     ↳ requiredbooleanResponse required indicator for the block
     ↳ min_characterintegerMinimum number of characters required (default 1)
     ↳ max_characterintegerMaximum number of charaters allowed (default null, means unlimited)
     ↳ no_spacingbooleanProhibition of spaces in response
↳ page_idstringUnique ID of the page

 

Short Text Answer (Regular expression)

KEYTypeDescription
↳ idstringUnique ID of the block
↳ typestringshort_text
↳ indexstringBlock numbering format in the form of P1B1
↳ contentstringContent of the question
↳ propertiesobject 
     ↳ visiblebooleanVisibility of the block
     ↳ hide_resultbooleanHiding result indicator
     ↳ encrypted_answerbooleanResponse data encryption
     ↳ formatstringAnswer format (free, regex)
     ↳ error_textstringError message
     ↳ guide_phrasestringGuide phrase
     ↳ sizestringInput box size (long, medium)
↳ validationsobject 
     ↳ requiredbooleanResponse required indicator for the block
     ↳ conditionstringRegular expression data condition
     ↳ patternstringRegular expression data pattern
↳ page_idstringUnique ID of the page

 

Numeric Value

KEYTypeDescription
↳ idstringUnique ID of the block
↳ typestringnumeric_value
↳ indexstringBlock numbering format in the form of P1B1
↳ contentstringContent of the question
↳ propertiesobject 
     ↳ visiblebooleanVisibility of the block
     ↳ hide_resultbooleanHiding result indicator
     ↳ encrypted_answerbooleanResponse data encryption
     ↳ guide_phrasestringGuide phrase
     ↳ sizestringInput box size (long, medium)
↳ validationsobject 
     ↳ requiredbooleanResponse required indicator for the block
     ↳ decimal_placesintegerDecimal limitation in response (0 ~ 5)
     ↳ min_numberintegerMinimum value of response
     ↳ max_numberintegerMaximum value of response
↳ page_idstringUnique ID of the page

 

Email Address

KEYTypeDescription
↳ idstringUnique ID of the block
↳ typestringemail
↳ indexstringBlock numbering format in the form of P1B1
↳ contentstringContent of the question
↳ propertiesobject 
     ↳ visiblebooleanVisibility of the block
     ↳ hide_resultbooleanHiding result indicator
     ↳ encrypted_answerbooleanResponse data encryption
     ↳ guide_phrasestringGuide phrase
     ↳ sizestringInput box size (long, medium)
↳ validationsobject 
     ↳ requiredbooleanResponse required indicator for the block
↳ page_idstringUnique ID of the page

 

Website

KEYTypeDescription
↳ idstringUnique ID of the block
↳ typestringurl
↳ indexstringBlock numbering format in the form of P1B1
↳ contentstringContent of the question
↳ propertiesobject 
     ↳ visiblebooleanVisibility of the block
     ↳ hide_resultbooleanHiding result indicator
     ↳ encrypted_answerbooleanResponse data encryption
     ↳ guide_phrasestringGuide phrase
     ↳ sizestringInput box size (long, medium)
↳ validationsobject 
     ↳ requiredbooleanResponse required indicator for the block
↳ page_idstringUnique ID of the page

 

Address

KEYTypeDescription
↳ idstringUnique ID of the block
↳ typestringaddress
↳ indexstringBlock numbering format in the form of P1B1
↳ contentstringContent of the question
↳ propertiesobject 
     ↳ visiblebooleanVisibility of the block
     ↳ hide_resultbooleanHiding result indicator
     ↳ encrypted_answerbooleanResponse data encryption
     ↳ address_typestringAddress type (general, korean)
     ↳ visible_fields[string]Visible address fields (street, detail, city, region, postal_code, country)
↳ validationsobject 
     ↳ requiredbooleanResponse required indicator for the block
     ↳ required_fields[string]Reauired address fields (street, detail, city,r egion, postal_code, country)
↳ page_idstringUnique ID of the page

 

File Upload

KEYTypeDescription
↳ idstringUnique ID of the block
↳ typestringfile_upload
↳ indexstringBlock numbering format in the form of P1B1
↳ contentstringContent of the question
↳ propertiesobject 
     ↳ visiblebooleanVisibility of the block
     ↳ hide_resultbooleanHiding result indicator
↳ validationsobject 
     ↳ requiredbooleanResponse required indicator for the block
     ↳ file_extensionsstringAllowed file extensions (comma-separated string)
     ↳ min_filesintegerMinimum number of files that can be uploaded
     ↳ max_filesintegerMaximum number of files that can be uploaded
↳ page_idstringUnique ID of the page