Survey Object v5

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

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

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

https://restapi.surveygizmo.com/v5/survey
ParametersExampleRequired
Authentication Credentialsapi_token=5D685159B6964FB69B044D3E7D2676D1True
pagepage=3False
resultsperpageresultsperpage=100False
filtersfilter[field][0]=subtype&filter[operator][1]==&filter[value][1]=surveyFalse

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

https://restapi.surveygizmo.com/v5/survey/123456
ParametersExampleRequired
Authentication Credentialsapi_token=5D685159B6964FB69B044D3E7D2676D1True
metaonly (exclude page info)falseFalse

CREATE SURVEY - Create a new survey. View Example Return.

https://restapi.surveygizmo.com/v5/survey/?_method=PUT&title=Title&type=survey
ParametersExampleRequired
Authentication Credentialsapi_token=5D685159B6964FB69B044D3E7D2676D1True
titleMy New SurveyTrue
typesurvey, form, poll, quizTrue
statuslaunched, closed, deletedFalse
theme*11147False
team456789False
options[internal_title]Internal TitleFalse
options[overall_quota]100False
options[auto_close]Y-m-d H:i:sFalse
blockbyNONE, IP, COOKIEFalse
Poll-Specific ParametersExampleRequired
polloptionspolloptions[0]=option 1&polloptions[1]=option 2True
polltyperadio, image, rankingFalse
pollwidth140, 300, 600False

*The theme parameter only supports saved themes in your Theme Library. To obtain the ID, go to Account > Libraries > Survey Themes and select the theme you wish to use. The ID will display in the URL.

UPDATE/COPY SURVEY - Update and/or copy a specified survey. View Example Return.

https://restapi.surveygizmo.com/v5/survey/123456?_method=POST
ParametersExampleRequired
Authentication Credentialsapi_token=5D685159B6964FB69B044D3E7D2676D1True
titleMy New SurveyFalse
statuslaunched, closed, deletedFalse
theme*11147False
team456789False
options[internal_title]Internal TitleFalse
options[overall_quota]100False
options[auto_close]Y-m-d H:i:sFalse
blockbyNONE, IP, COOKIEFalse
copytrueFalse
Poll-Specific ParametersExampleRequired
polloptionspolloptions[0]=option 1&polloptions[1]=option 2False
polltyperadio, image, rankingFalse

*The theme parameter only supports saved themes in your Theme Library. To obtain the ID, go to Account > Libraries > Survey Themes and select the theme you wish to use. The ID will display in the URL.

DELETE SURVEY - Delete a specified survey. View Example Return.

https://restapi.surveygizmo.com/v5/survey/123456?_method=DELETE
ParametersExampleRequired
Authentication Credentialsapi_token=5D685159B6964FB69B044D3E7D2676D1True

Back to the Top