List Survey Questions
Returns a list of all questions for the specified survey.
Endpoint
GET
v5/survey/{survey_id}/surveyquestion
Requires authentication
Path Parameters
The survey whose questions should be retrieved.
survey_id
string
required
The ID of the survey whose questions will be listed.
Query Parameters
This endpoint does not accept additional query parameters beyond authentication credentials.
None
Response
Returns a paginated list of question objects for the specified survey. The list includes all question types — text inputs, choice questions, essay fields, hidden fields, decorative elements, and actions.
result_ok
boolean
Whether the request succeeded.
total_count
integer
Total number of questions in the survey.
page
integer
Current page index.
total_pages
integer
Number of available pages.
results_per_page
integer
Number of questions returned per page.
data
array
Array of survey question objects.
child attributes
id
integer
The unique ID of the question.
base_type
string
The base object type. Possible values:
Question, Action, Decorative.type
string
The question type in uppercase (e.g.
TEXTBOX, CHECKBOX, ESSAY, HIDDEN, INSTRUCTIONS).title
object
The question text, keyed by language (e.g.
English).shortname
string | null
The question's shortname or alias. Empty string if not set;
null for decorative types.varname
array | object
The SPSS variable name(s) for the question. Returns an empty array if not set; returns a keyed object for multi-field question types.
description
array | object
The question description or sub-text, keyed by language. Returns an empty array if not set.
has_showhide_deps
boolean | null
Whether other questions depend on this question's answer via display or skip logic. Returns
null for action and decorative types.comment
boolean | null
Whether a comment field is enabled on this question. Returns
null for decorative types.properties
object
Configuration properties for the question. The fields present vary by question type.
child attributes
required
boolean
Whether the question is required.
hidden
boolean
Whether the question is hidden from respondents.
disabled
boolean
Whether the question is disabled and cannot be answered.
soft-required
boolean
Whether soft-required validation is enabled, prompting respondents who skip without blocking advancement.
option_sort
string
Sort order for answer options. Possible values:
NONE, ALPHA, SHUFFLE.orientation
string
Display orientation of answer options. Possible values:
HORZ, VERT.labels_right
boolean
Whether option labels are positioned to the right of the input.
show_title
boolean
Whether the question title is displayed to respondents.
question_description
object
The question description text, keyed by language.
question_description_above
boolean
Whether the description is displayed above the question title rather than below.
save_logic_data
boolean
Whether display and skip logic data is saved with this question.
hide_after_response
boolean
Whether the question is hidden after the respondent answers it.
admin_question
boolean
Whether the question is admin-only, visible only in admin reports.
custom_css
string | null
Custom CSS applied to this question. Empty string or
null if not set.break_after
boolean
Whether a page break is inserted after this question.
url
string
The redirect or webhook URL for applicable question types. Returns
http:// if not set.messages
object
Label and message overrides for the question. Fields include
inputmask, r_extreme_label, l_extreme_label, th_content, and others. Returns empty arrays for any fields that have not been set.element_style
string
The visual style applied to the question's input elements.
map_key
string
Internal key identifying the question's template type (e.g.
text, essay, checkbox, hidden, instructions).defaulttext
object
Default text pre-populated in the question field, keyed by language. Present on hidden/action question types.
exclude_number
string
Whether the question number is excluded from the display. Returns
YES when enabled. Present on action question types.options
array
The answer options for the question. Empty array for question types that do not use options (e.g. text, essay, hidden).
child attributes
id
integer
The unique SKU/ID of the answer option.
title
object
The option label, keyed by language.
value
string
The reporting value for the option.
properties
object
Properties for the option. Includes
disabled (boolean) — whether this option is disabled and cannot be selected.show_rules_ids
string | null
The ID of the display logic rule set applied to this question. Returns
null if no display logic is set.Examples
Note GET requests are cached for 60 seconds. Repeated identical requests within that window will return cached results.
Request (cURL)
curl -X GET "https://api.alchemer.com/v5/survey/123456/surveyquestion?api_token=YOUR_API_TOKEN&api_token_secret=YOUR_API_TOKEN_SECRET"
Response
{
"result_ok": true,
"total_count": 8,
"page": 1,
"total_pages": 1,
"results_per_page": 8,
"data": [
{
"id": 2,
"base_type": "Question",
"type": "TEXTBOX",
"title": { "English": "Input 1" },
"shortname": "hello",
"varname": [],
"description": [],
"has_showhide_deps": false,
"comment": false,
"properties": {
"required": false,
"hidden": false,
"orientation": "VERT",
"option_sort": "NONE",
"soft-required": false,
"disabled": false,
"hide_after_response": false,
"admin_question": false,
"custom_css": "",
"break_after": false,
"url": "http://"
},
"options": [],
"show_rules_ids": null
},
{
"id": 82,
"base_type": "Action",
"type": "HIDDEN",
"title": { "English": "teams_message" },
"shortname": "",
"varname": [],
"description": [],
"has_showhide_deps": null,
"comment": false,
"properties": {
"required": false,
"hidden": false,
"disabled": false,
"exclude_number": "YES",
"hide_after_response": false,
"admin_question": false,
"custom_css": null
},
"options": [],
"show_rules_ids": null
},
{
"id": 1,
"base_type": "Decorative",
"type": "INSTRUCTIONS",
"title": { "English": "Thank you for taking our survey. Your response is very important to us." },
"shortname": null,
"varname": [],
"description": [],
"has_showhide_deps": null,
"comment": null,
"properties": {
"hidden": false,
"map_key": "instructions"
},
"options": [],
"show_rules_ids": null
}
]
}