Return Formats and Fields

 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 API returns data as json by default, but you can also choose to return data in pson, xml and a 'debug' format. Simply specify the format as the file extension in the url.

json restapi.surveygizmo.com/v4/survey/123456/surveypage/1.json
pson restapi.surveygizmo.com/v4/survey/123456/surveypage/1.pson
xml restapi.surveygizmo.com/v4/survey/123456/surveypage/1.xml
debug restapi.surveygizmo.com/v4/survey/123456/surveypage/1.debug
jsonp* restapi.surveygizmo.com/v4/survey/123456/surveypage/1.jsonp

*We recommend creating a new API Key and restricting this API Key to GET access when using jsonp.

The API returns various fields for each object. The returned fields for many objects are straightforward. For more complex objects, we provide a list of the returned fields; check out the below linked documents for more info.