Fetching Form Details

Fetches detailed information for a specific form (form_id).

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

 

REQUEST

Path Parameters

Key	Description
form_id	Required, Unique ID of the form

 

RESPONSE

Key	Type	Description
long_id	string	Unique ID of the form
id	string	long_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.
name	string	File name of the form
status	string	Form status (one of editing, pending, collecting, closed)
pages	[object]
↳ id	string	Unique ID of the page
↳ number	integer	Page number
↳ visible	boolean	Page visibility
↳ blocks_count	integer	Number of blocks included
blocks	[object]	(Described in a separate table below. Replace the ... position for each blocks)
...	...	...
welcome_page	object
↳ content	string	Welcome page content
thankyou_pages	[object]
↳ id	string	Unique ID of Thank you page
↳ content	string	Thank you page content
variables	[object]
↳ id	string	Unique ID of the defined variable
↳ name	string	Name of the defined variable
↳ formula	string	Formula of the defined variable
owned	boolean
created_at	string	Form creation timestamp
last_updated_at	string	Last form modification timestamp
published_at	string	Last form publication timestamp

 

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

Information

KEY	Type	Description
↳ id	string	Unique ID of the block
↳ type	string	information
↳ index	string	Block numbering format in the form of P1B1
↳ content	string	Information content
↳ ribbon_text	string	Information title
↳ properties	object
↳ visible	boolean	Visibility of the block
↳ page_id	string	Unique ID of the page

 

Line Shape

KEY	Type	Description
↳ id	string	Unique ID of the block
↳ type	string	line_shape
↳ index	string	Block numbering format in the form of P1B1
↳ properties	object
↳ visible	boolean	Visibility of the block
↳ shape	string	Line shape (zigzag...)
↳ page_id	string	Unique ID of the page

 

Single Choice

KEY	Type	Description
↳ id	string	Unique ID of the block
↳ type	string	single_choice
↳ index	string	Block numbering format in the form of P1B1
↳ content	string	Content of the question
↳ properties	object
↳ visible	boolean	Visibility of the block
↳ hide_result	boolean	Hiding result indicator
↳ allow_other_choice	boolean	Allow 'Other' option
↳ randomize	boolean	Randomization of choices order
↳ assign_score	boolean	Score assignment
↳ choices	[object]
↳ id	string	Unique ID of the choice
↳ index	string	Choice numbering format in the form of P1B1C1
↳ label	string	Content of the choice
↳ score	integer	Score assigned to the choice
↳ visible	boolean	Visibility of the choice
↳ is_other	boolean	Is 'Other' option (only with allow_other_choice=true)
↳ validations	object
↳ required	boolean	Response required indicator for the block
↳ required_other	boolean	Comments required indicator for 'Other' choice (only with allow_other_choice=true)
↳ page_id	string	Unique ID of the page

 

Dropdown

KEY	Type	Description
↳ id	string	Unique ID of the block
↳ type	string	dropdown
↳ index	string	Block numbering format in the form of P1B1
↳ content	string	Content of the question
↳ properties	object
↳ visible	boolean	Visibility of the block
↳ hide_result	boolean	Hiding result indicator
↳ allow_other_choice	boolean	Allow 'Other' option
↳ randomize	boolean	Randomization of choices order
↳ assign_score	boolean	Score assignment
↳ choices	[object]
↳ id	string	Unique ID of the choice
↳ index	string	Choice numbering format in the form of P1B1C1
↳ label	string	Content of the choice
↳ score	integer	Score assigned to the choice
↳ visible	boolean	Visibility of the choice
↳ is_other	boolean	Is 'Other' option (only with allow_other_choice=true)
↳ validations	object
↳ required	boolean	Response required indicator for the block
↳ required_other	boolean	Comments required indicator for 'Other' choice (only with allow_other_choice=true)
↳ page_id	string	Unique ID of the page

 

Multiple Choice

KEY	Type	Description
↳ id	string	Unique ID of the block
↳ type	string	multiple_choice
↳ index	string	Block numbering format in the form of P1B1
↳ content	string	Content of the question
↳ properties	object
↳ visible	boolean	Visibility of the block
↳ hide_result	boolean	Hiding result indicator
↳ allow_other_choice	boolean	Allow 'Other' option
↳ randomize	boolean	Randomization of choices order
↳ assign_score	boolean	Score assignment
↳ choices	[object]
↳ id	string	Unique ID of the choice
↳ index	string	Choice numbering format in the form of P1B1C1
↳ label	string	Content of the choice
↳ score	integer	Score assigned to the choice
↳ visible	boolean	Visibility of the choice
↳ is_other	boolean	Is 'Other' option (only with allow_other_choice=true)
↳ validations	object
↳ required	boolean	Response required indicator for the block
↳ required_other	boolean	Comments required indicator for 'Other' choice  (only with allow_other_choice=true)
↳ min_selection	integer	Minimum number of choices can be selected
↳ max_selection	integer	Maximum number of choices can be selected
↳ page_id	string	Unique ID of the page

 

Ranking

KEY	Type	Description
↳ id	string	Unique ID of the block
↳ type	string	ranking
↳ index	string	Block numbering format in the form of P1B1
↳ content	string	Content of the question
↳ properties	[object]
↳ visible	boolean	Visibility of the block
↳ hide_result	boolean	Hiding result indicator
↳ allow_other_choice	boolean	Allow 'Other' option
↳ randomize	boolean	Randomization of choices order
↳ choices	[object]
↳ id	string	Unique ID of the choice
↳ index	string	Choice numbering format in the form of P1B1C1
↳ label	string	Content of the choice
↳ visible	boolean	Visibility of the choice
↳ is_other	boolean	Is 'Other' option (only with allow_other_choice=true)
↳ validations	object
↳ required	boolean	Response required indicator for the block
↳ required_other	boolean	Comments required indicator for 'Other' choice (only with allow_other_choice=true)
↳ min_selection	integer	Minimum number of choices can be selected
↳ max_selection	integer	Maximum number of choices can be selected
↳ page_id	string	Unique ID of the page

 

Matrix Single Choice

KEY	Type	Description
↳ id	string	Unique ID of the block
↳ type	string	matrix_single_choice
↳ index	string	Block numbering format in the form of P1B1
↳ content	string	Content of the question
↳ properties	object
↳ visible	boolean	Visibility of the block
↳ hide_result	boolean	Hiding result indicator
↳ assign_score	boolean	Score assignment
↳ blocks	[object]
↳ id	string	Unique ID of the sub-question
↳ index	string	Sub-question numbering format in the form of P1B1.1
↳ content	string	Content of the sub-question
↳ visible	boolean	Visibility of the sub-question
↳ properties	object
↳ choices	[object]
↳ id	string	Unique ID of the choice
↳ index	string	Choice numbering format in the form of P1B1.1C1
↳ label	string	Content of the choice
↳ score	integer	Score assigned to the choice
↳ visible	boolean	Visibility of the choice
↳ validations	object
↳ required	boolean	Response required indicator for the block
↳ page_id	string	Unique ID of the page

 

Matrix Multiple Choice

KEY	Type	Description
↳ id	string	Unique ID of the block
↳ type	string	matrix_multiple_choice
↳ index	string	Block numbering format in the form of P1B1
↳ content	string	Content of the question
↳ properties	object
↳ visible	boolean	Visibility of the block
↳ hide_result	boolean	Hiding result indicator
↳ assign_score	boolean	Score assignment
↳ blocks	[object]
↳ id	string	Unique ID of the sub-question
↳ index	string	Sub-question numbering format in the form of P1B1.1
↳ content	string	Content of the sub-question
↳ visible	boolean	Visibility of the sub-question
↳ properties	object
↳ choices	[object]
↳ id	string	Unique ID of the choice
↳ index	string	Choice numbering format in the form of P1B1.1C1
↳ label	string	Content of the choice
↳ score	integer	Score assigned to the choice
↳ visible	boolean	Visibility of the choice
↳ validations	object
↳ required	boolean	Response required indicator for the block
↳ min_selection	integer	Minimum number of choices can be selected
↳ max_selection	integer	Maximum number of choices can be selected
↳ page_id	string	Unique ID of the page

 

Matrix Ranking

KEY	Type	Description
↳ id	string	Unique ID of the block
↳ type	string	matrix_ranking
↳ index	string	Block numbering format in the form of P1B1
↳ content	string	Content of the question
↳ properties	object
↳ visible	boolean	Visibility of the block
↳ hide_result	boolean	Hiding result indicator
↳ blocks	[object]
↳ id	string	Unique ID of the sub-question
↳ index	string	Sub-question numbering format in the form of P1B1.1
↳ content	string	Content of the sub-question
↳ visible	boolean	Visibility of the sub-question
↳ properties	object
↳ choices	[object]
↳ id	string	Unique ID of the choice
↳ index	string	Choice numbering format in the form of P1B1.1C1
↳ label	string	Content of the choice
↳ visible	boolean	Visibility of the choice
↳ validations	object
↳ required	boolean	Response required indicator for the block
↳ min_selection	integer	Minimum number of choices can be selected
↳ max_selection	integer	Maximum number of choices can be selected
↳ page_id	string	Unique ID of the page

 

Media Single Choice

KEY	Type	Description
↳ id	string	Unique ID of the block
↳ type	string	media_single_choice
↳ index	string	Block numbering format in the form of P1B1
↳ content	string	Content of the question
↳ properties	object
↳ visible	boolean	Visibility of the block
↳ hide_result	boolean	Hiding result indicator
↳ allow_other_choice	boolean	Allow 'Other' option
↳ randomize	boolean	Randomization of choices order
↳ assign_score	boolean	Score assignment
↳ choices	[object]
↳ id	string	Unique ID of the choice
↳ index	string	Choice numbering format in the form of P1B1C1
↳ label	string	Content of the choice
↳ score	integer	Score assigned to the choice
↳ visible	boolean	Visibility of the choice
↳ is_other	boolean	Is 'Other' option (only with allow_other_choice=true)
↳ media	object	Does not appear if no image attached or it is 'Other'.
↳ type	string	Media type (currently returns only 'image')
↳ url	string	Media URL
↳ width	integer	Media width
↳ height	integer	Media height
↳ media	object
↳ fill	string	Media fill method in choice
↳ size	string	Media size in choice
↳ validations	object
↳ required	boolean	Response required indicator for the block
↳ required_other	boolean	Comments required indicator for 'Other' choice (only with allow_other_choice=true)
↳ page_id	string	Unique ID of the page

 

Media Multiple Choice

KEY	Type	Description
↳ id	string	Unique ID of the block
↳ type	string	media_multiple_choice
↳ index	string	Block numbering format in the form of P1B1
↳ content	string	Content of the question
↳ properties	object
↳ visible	boolean	Visibility of the block
↳ hide_result	boolean	Hiding result indicator
↳ allow_other_choice	boolean	Allow 'Other' option
↳ randomize	boolean	Randomization of choices order
↳ assign_score	boolean	Score assignment
↳ choices	[object]
↳ id	string	Unique ID of the choice
↳ index	string	Choice numbering format in the form of P1B1C1
↳ label	string	Content of the choice
↳ score	integer	Score assigned to the choice
↳ visible	boolean	Visibility of the choice
↳ is_other	boolean	Is 'Other' option (only with allow_other_choice=true)
↳ media	object	Does not appear if no image attached or it is 'Other'.
↳ type	string	Media type (currently returns only 'image')
↳ url	string	Media URL
↳ width	integer	Media width
↳ height	integer	Media height
↳ media	object
↳ fill	string	Media fill method in choice
↳ size	string	Media size in choice
↳ validations	object
↳ required	boolean	Response required indicator for the block
↳ required_other	boolean	Comments required indicator for 'Other' choice (only with allow_other_choice=true)
↳ min_selection	integer	Minimum number of choices can be selected
↳ max_selection	integer	Maximum number of choices can be selected
↳ page_id	string	Unique ID of the page

 

Media Ranking

KEY	Type	Description
↳ id	string	Unique ID of the block
↳ type	string	media_ranking
↳ index	string	Block numbering format in the form of P1B1
↳ content	string	Content of the question
↳ properties	object
↳ visible	boolean	Visibility of the block
↳ hide_result	boolean	Hiding result indicator
↳ allow_other_choice	boolean	Allow 'Other' option
↳ randomize	boolean	Randomization of choices order
↳ choices	[object]
↳ id	string	Unique ID of the choice
↳ index	string	Choice numbering format in the form of P1B1C1
↳ label	string	Content of the choice
↳ score	integer	Score assigned to the choice
↳ visible	boolean	Visibility of the choice
↳ is_other	boolean	Is 'Other' option (only with allow_other_choice=true)
↳ media	object	Does not appear if no image attached or it is 'Other'.
↳ type	string	Media type (currently returns only 'image')
↳ url	string	Media URL
↳ width	integer	Media width
↳ height	integer	Media height
↳ media	object
↳ fill	string	Media fill method in choice
↳ size	string	Media size in choice
↳ validations	object
↳ required	boolean	Response required indicator for the block
↳ required_other	boolean	Comments required indicator for 'Other' choice (only with allow_other_choice=true)
↳ min_selection	integer	Minimum number of choices can be selected
↳ max_selection	integer	Maximum number of choices can be selected
↳ page_id	string	Unique ID of the page

 

Point Scale

KEY	Type	Description
↳ id	string	Unique ID of the block
↳ type	string	point_scale
↳ index	string	Block numbering format in the form of P1B1
↳ content	string	Content of the question
↳ properties	object
↳ visible	boolean	Visibility of the block
↳ hide_result	boolean	Hiding result indicator
↳ shape	boolean	Scale shape
↳ steps	integer	Scale step
↳ scales	[integer]	Scale range (eg: [-5, -4, -3, -2, -1, 0, 1, 2, 3, 4, 5])
↳ label	[object]
↳ left	string	Scale left label
↳ center	string	Scale center label
↳ right	string	Scale right label
↳ validations	object
↳ required	boolean	Response required indicator for the block
↳ page_id	string	Unique ID of the page

 

NPS

KEY	Type	Description
↳ id	string	Unique ID of the block
↳ type	string	nps
↳ index	string	Block numbering format in the form of P1B1
↳ content	string	Content of the question
↳ properties	object
↳ visible	boolean	Visibility of the block
↳ hide_result	boolean	Hiding result indicator
↳ shape	boolean	Scale shape
↳ steps	integer	Scale step (11 for NPS)
↳ scales	[integer]	Scale range ([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10] or NPS)
↳ validations	object
↳ required	boolean	Response required indicator for the block
↳ page_id	string	Unique ID of the page

 

Star Rating

KEY	Type	Description
↳ id	string	Unique ID of the block
↳ type	string	rating
↳ index	string	Block numbering format in the form of P1B1
↳ content	string	Content of the question
↳ properties	object
↳ visible	boolean	Visibility of the block
↳ hide_result	boolean	Hiding result indicator
↳ shape	boolean	Rating shape
↳ steps	integer	Rating step
↳ show_step_count	boolean	Score visibility
↳ validations	object
↳ required	boolean	Response required indicator for the block
↳ page_id	string	Unique ID of the page

 

Long Text Answer (Free)

KEY	Type	Description
↳ id	string	Unique ID of the block
↳ type	string	long_text
↳ index	string	Block numbering format in the form of P1B1
↳ content	string	Content of the question
↳ properties	object
↳ visible	boolean	Visibility of the block
↳ hide_result	boolean	Hiding result indicator
↳ encrypted_answer	boolean	Response data encryption
↳ format	string	Answer format (free, regex)
↳ guide_phrase	string	Guide phrase
↳ size	string	Input box size (large, small)
↳ validations	object
↳ required	boolean	Response required indicator for the block
↳ min_character	integer	Minimum number of characters required (default 1)
↳ max_character	integer	Maximum number of charaters allowed (default null, means unlimited)
↳ page_id	string	Unique ID of the page

 

Long Text Answer (Regular expression)

KEY	Type	Description
↳ id	string	Unique ID of the block
↳ type	string	long_text
↳ index	string	Block numbering format in the form of P1B1
↳ content	string	Content of the question
↳ properties	object
↳ visible	boolean	Visibility of the block
↳ hide_result	boolean	Hiding result indicator
↳ encrypted_answer	boolean	Response data encryption
↳ format	string	Answer format (free, regex)
↳ error_text	string	Error message
↳ guide_phrase	string	Guide phrase
↳ size	string	Input box size (large, small)
↳ validations	object
↳ required	boolean	Response required indicator for the block
↳ condition	string	Regular expression data condition
↳ pattern	string	Regular expression data pattern
↳ page_id	string	Unique ID of the page

 

Short Text Answer (Free)

KEY	Type	Description
↳ id	string	Unique ID of the block
↳ type	string	short_text
↳ index	string	Block numbering format in the form of P1B1
↳ content	string	Content of the question
↳ properties	object
↳ visible	boolean	Visibility of the block
↳ hide_result	boolean	Hiding result indicator
↳ encrypted_answer	boolean	Response data encryption
↳ format	string	Answer format (free, regex)
↳ guide_phrase	string	Guide phrase
↳ size	string	Input box size (long, medium)
↳ validations	object
↳ required	boolean	Response required indicator for the block
↳ min_character	integer	Minimum number of characters required (default 1)
↳ max_character	integer	Maximum number of charaters allowed (default null, means unlimited)
↳ no_spacing	boolean	Prohibition of spaces in response
↳ page_id	string	Unique ID of the page

 

Short Text Answer (Regular expression)

KEY	Type	Description
↳ id	string	Unique ID of the block
↳ type	string	short_text
↳ index	string	Block numbering format in the form of P1B1
↳ content	string	Content of the question
↳ properties	object
↳ visible	boolean	Visibility of the block
↳ hide_result	boolean	Hiding result indicator
↳ encrypted_answer	boolean	Response data encryption
↳ format	string	Answer format (free, regex)
↳ error_text	string	Error message
↳ guide_phrase	string	Guide phrase
↳ size	string	Input box size (long, medium)
↳ validations	object
↳ required	boolean	Response required indicator for the block
↳ condition	string	Regular expression data condition
↳ pattern	string	Regular expression data pattern
↳ page_id	string	Unique ID of the page

 

Numeric Value

KEY	Type	Description
↳ id	string	Unique ID of the block
↳ type	string	numeric_value
↳ index	string	Block numbering format in the form of P1B1
↳ content	string	Content of the question
↳ properties	object
↳ visible	boolean	Visibility of the block
↳ hide_result	boolean	Hiding result indicator
↳ encrypted_answer	boolean	Response data encryption
↳ guide_phrase	string	Guide phrase
↳ size	string	Input box size (long, medium)
↳ validations	object
↳ required	boolean	Response required indicator for the block
↳ decimal_places	integer	Decimal limitation in response (0 ~ 5)
↳ min_number	integer	Minimum value of response
↳ max_number	integer	Maximum value of response
↳ page_id	string	Unique ID of the page

 

Email Address

KEY	Type	Description
↳ id	string	Unique ID of the block
↳ type	string	email
↳ index	string	Block numbering format in the form of P1B1
↳ content	string	Content of the question
↳ properties	object
↳ visible	boolean	Visibility of the block
↳ hide_result	boolean	Hiding result indicator
↳ encrypted_answer	boolean	Response data encryption
↳ guide_phrase	string	Guide phrase
↳ size	string	Input box size (long, medium)
↳ validations	object
↳ required	boolean	Response required indicator for the block
↳ page_id	string	Unique ID of the page

 

Website

KEY	Type	Description
↳ id	string	Unique ID of the block
↳ type	string	url
↳ index	string	Block numbering format in the form of P1B1
↳ content	string	Content of the question
↳ properties	object
↳ visible	boolean	Visibility of the block
↳ hide_result	boolean	Hiding result indicator
↳ encrypted_answer	boolean	Response data encryption
↳ guide_phrase	string	Guide phrase
↳ size	string	Input box size (long, medium)
↳ validations	object
↳ required	boolean	Response required indicator for the block
↳ page_id	string	Unique ID of the page

 

Address

KEY	Type	Description
↳ id	string	Unique ID of the block
↳ type	string	address
↳ index	string	Block numbering format in the form of P1B1
↳ content	string	Content of the question
↳ properties	object
↳ visible	boolean	Visibility of the block
↳ hide_result	boolean	Hiding result indicator
↳ encrypted_answer	boolean	Response data encryption
↳ address_type	string	Address type (general, korean)
↳ visible_fields	[string]	Visible address fields (street, detail, city, region, postal_code, country)
↳ validations	object
↳ required	boolean	Response required indicator for the block
↳ required_fields	[string]	Reauired address fields (street, detail, city,r egion, postal_code, country)
↳ page_id	string	Unique ID of the page

 

File Upload

KEY	Type	Description
↳ id	string	Unique ID of the block
↳ type	string	file_upload
↳ index	string	Block numbering format in the form of P1B1
↳ content	string	Content of the question
↳ properties	object
↳ visible	boolean	Visibility of the block
↳ hide_result	boolean	Hiding result indicator
↳ validations	object
↳ required	boolean	Response required indicator for the block
↳ file_extensions	string	Allowed file extensions (comma-separated string)
↳ min_files	integer	Minimum number of files that can be uploaded
↳ max_files	integer	Maximum number of files that can be uploaded
↳ page_id	string	Unique ID of the page