sgapiGetQuestionProperty(%%questionID, %%property)

Important Update to Custom Scripting

SurveyGizmo's CustomScript Action now supports the LUA programming language. Visit our NEW Lua Scripting Resources!

Legacy Custom Scripting Language Deprecation Plans 

  1. New accounts (created after October 29, 2018) will only have the option to use Lua in scripts.
  2. As of October 29, 2018 Custom Scripting Actions will default to Lua as the scripting type in the Custom Scripting Action for accounts created before this date. You will be able to switch to the Legacy Custom Scripting; though we highly encourage using Lua.
  3. In the long term, Legacy Custom Scripting Actions will be switched to read-only. The exact date on this is to be determined; we will send notifications well ahead of time.

This function returns the given property to the given question.

Possible Properties Return Values
exclude_number boolean
labels_right boolean
orientation VERT/HORZ
question_description_above boolean
custom_css Template CSS hook name
required boolean
force_percent boolean
force_currency boolean
min_number value
max_number, value value
min_answers_per_row value
minimum_response value
defaulttext text/reporting value
max_total value
max_total_noshow boolean


The below script gets the required property for question ID 2.

%%questionID = 2;
%%property = 'required';

sgapiGetQuestionProperty(%%questionID, %%property);