« Back to Documentation Overview

get_surveys

Section: Surveys
Version: 1.5.0


Get surveys.


Parameters
stringAPI_KEY
object
stringstatusvalue
objectname
stringOPERATORvalue
Return Value
objectSURVEY_ID
stringnameMy survey 2
stringtitleget_surveys_title__string
stringdescriptionget_surveys_description__string
objectquestions
objectQUESTION_ID
stringnameTruth or dare?
stringnoteget_surveys_note__string
objectoptions
objectOPTION_ID
stringnameDare
stringstatuspublished
stringcreated_on2012-02-02 00:00:00

Example Request JSON

[
    "API_KEY",
    {
        "status": "value",
        "name": {
            "OPERATOR": "value"
        }
    }
]

Example Response JSON

{
    "SURVEY_ID": {
        "name": "My survey 2",
        "title": null,
        "description": null,
        "questions": {
            "QUESTION_ID": {
                "name": "Truth or dare?",
                "note": null,
                "options": {
                    "OPTION_ID": {
                        "name": "Dare"
                    }
                }
            }
        },
        "status": "published",
        "created_on": "2012-02-02 00:00:00"
    }
}
API-wide Errors
API key verification failed API key verification failed
API client IP not allowed API client IP not allowed
Invalid params Attribute params must be reference to hash