SurveyQuestion Sub-Object

 Help Us Improve Our API Documentation!

We're beginning an initiative to improve our API docs. We would love your help!

Please take this quick 4-question survey to help us out! Thank you in advance for your time!

The following API calls are currently available for the SurveyQuestion object:

For info on returned fields and example returns go to SurveyQuestion Returned Fields.

GET LIST - Get a list of all of your survey questions. View Example Return.

https://restapi.surveygizmo.com/v4/survey/123456/surveyquestion
Parameters Example Required
Authentication Credentials api_token=5D685159B6964FB69B044D3E7D2676D1 True

GET SURVEYQUESTION - Get information about a specified survey question. View Example Return.

https://restapi.surveygizmo.com/v4/survey/123456/surveyquestion/1
Parameters Example Required
Authentication Credentials api_token=5D685159B6964FB69B044D3E7D2676D1 True

CREATE SURVEYQUESTION - Create a new survey question. View Example Return.

https://restapi.surveygizmo.com/v4/survey/123456/surveypage/1/surveyquestion?_method=PUT
Parameters Example Required
Authentication Credentials api_token=5D685159B6964FB69B044D3E7D2676D1 True
surveypage ID of page to add question to True
type radio, checkbox, menu, text, essay, email, multitext, single-image, multi-image, contsum, rank-dragdrop, table-radio, table-checkbox, table-textbox, table-menu-matrix, table-stars, file, instructions, media, hidden, urlredirect False
title Question text False
description Description text False
after Question ID to follow False
varname SPSS Variable Name* False
shortname Shortname/Alias False
Look & Feel Properties Example Required
properties[disabled] true False
properties[exclude_number] true False
properties[hide_after_response] true False
properties[option_sort] true False
properties[orientation] HORZ,VERT False
properties[labels_right] true False
properties[question_description_above] true False
properties[custom_css] CSS template hook False
Validation Properties Example Required
properties[required] true False
properties[soft-required] true False
properties[force_numeric] true False
properties[force_percent] true False
properties[force_currency] true False
properties[subtype] email, date False
properties[min_number] value False
properties[max_number] value False
properties[min_answers_per_row] value False
properties[minimum_response] value False
properties[inputmask][mask] RegEx Pattern False
properties[inputmask][message] RegEx Pattern False
properties[defaulttext] Default text or reporting value False
Logic Properties Example Required
properties[hidden] true False
properties[piped_from] Question ID to pipe from False
Continuous Sum Properties Example Required
properties[max_total] value False
properties[max_total_noshow] true False
properties[must_be_max] true False
File Upload Properties Example Required
properties[maxfiles] 1-10 False
properties[extentions] png,gif,jpg,doc,xls,docx,xlsx,pdf,txt False
URL Redirect Properties Example Required
properties[url] Redirect URL False
properties[outbound][n][fieldname] Variable Name False
properties[outbound][n][mapping] Question ID for variable you wish to map False
properties[outbound][n][default] Default Value to be passed when blank False

*For question types with multiple fields this must be specified as an array with the option ID as the key. For example, the follow call is used to specify the SPSS variable names for each row of a Textbox List question.
https://restapi.surveygizmo.com/v4/survey/2120303/surveypage/12/surveyquestion/23.debug?_method=POST&varname[10001]=Comedy&varname[10002]=Drama&varname[10003]=Foreign&varname[10004]=Western

Back to the Top

UPDATE SURVEYQUESTION - Update a specified surveyquestion. View Example Return.

https://restapi.surveygizmo.com/v4/survey/123456/surveyquestion/1?_method=POST
Parameters Example Required
Authentication Credentials api_token=5D685159B6964FB69B044D3E7D2676D1 True
title Question text False
description Description text False
varname SPSS Variable Name* False
shortname Shortname/Alias False
Look & Feel Properties Example Required
properties[disabled] true False
properties[exclude_number] true False
properties[hide_after_response] true False
properties[option_sort] true False
properties[orientation] HORZ,VERT False
properties[labels_right] true False
properties[question_description_above] true False
properties[custom_css] CSS template hook False
Validation Properties Example Required
properties[required] true False
properties[soft-required] true False
properties[force_numeric] true False
properties[force_percent] true False
properties[force_currency] true False
properties[min_number] value False
properties[max_number] value False
properties[min_answers_per_row] value False
properties[minimum_response] value False
properties[inputmask] RegEx Pattern False
properties[defaulttext] Default text or reporting value False
Logic Properties Example Required
properties[hidden] true False
properties[piped_from] Question ID to pipe from False
Continuous Sum Properties Example Required
properties[max_total] value False
properties[max_total_noshow] true False
properties[must_be_max] true False
File Upload Properties Example Required
properties[maxfiles] 1-10 False
properties[extentions] png,gif,jpg,doc,xls,docx,xlsx,pdf,txt False
URL Redirect Properties Example Required
properties[url] Redirect URL False
properties[outbound][n][fieldname] Variable Name False
properties[outbound][n][mapping]

Question ID for variable you wish to map or url if mapping from a URL variable

False
properties[outbound][n][url] The name of the URL variable mapped from, if mapping from a URL variable
properties[outbound][n][default] Default Value to be passed when blank False

*For question types with multiple fields this must be specified as an array with the option ID as the key. For example, the follow call is used to specify the SPSS variable names for each row of a Textbox List question.
https://restapi.surveygizmo.com/v4/survey/2120303/surveypage/12/surveyquestion/23.debug?_method=POST&varname[10001]=Comedy&varname[10002]=Drama&varname[10003]=Foreign&varname[10004]=Western

DELETE SURVEYQUESTION - Delete a specified survey question. View Example Return.

Deleting grid rows is not supported.

https://restapi.surveygizmo.com/v4/survey/123456/surveyquestion/1?_method=DELETE
Parameters Example Required
Authentication Credentials api_token=5D685159B6964FB69B044D3E7D2676D1 True
Back to the Top