Get Survey Question
Returns detailed information about a specified survey question, including its type, title, options, and configuration properties.
Endpoint
GET
v5/survey/{survey_id}/surveyquestion/{question_id}
Requires authentication
Path Parameters
The survey and specific question to retrieve.
survey_id
string
required
The ID of the survey the question belongs to.
question_id
string
required
The ID of the specific question to retrieve.
Query Parameters
This endpoint does not accept additional query parameters beyond authentication credentials.
None
Response
Returns a single survey question object wrapped in a data envelope.
result_ok
boolean
Whether the request succeeded.
data
object
The survey question object.
child attributes
id
integer
The unique ID of the question.
base_type
string
The base object type. Always
Question for this endpoint.type
string
The question type in uppercase (e.g.
CHECKBOX, RADIO, TEXTBOX, ESSAY, HIDDEN).title
object
The question text, keyed by language (e.g.
English).shortname
string
The question's shortname or alias. Empty string if not set.
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
Whether other questions depend on this question's answer via display or skip logic.
comment
boolean
Whether a comment field is enabled on this question.
show_rules_ids
string
The ID of the display logic rule set currently applied to this question, if any. Empty string if none.
properties
object
Configuration properties for the question. The fields present vary by question type.
child attributes
option_sort
string
Sort order for answer options. Possible values:
NONE, ALPHA, SHUFFLE.required
boolean
Whether the question is required.
hidden
boolean
Whether the question is hidden from respondents.
element_style
string
The visual style applied to the question's input elements.
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.
soft-required
boolean
Whether soft-required validation is enabled, prompting respondents who skip without blocking advancement.
disabled
boolean
Whether the question is disabled and cannot be answered.
save_logic_data
boolean
Whether display and skip logic data is saved with this question.
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.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
Custom CSS applied to this question. Empty string 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.show_rules
object
The display logic rule currently applied to this question, if any. Contains the rule's
id, operator, and atom / atom2 condition objects. Returns an empty object if no rule is set.options
array
The answer options for the question. Empty array if the question type does not use options.
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.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/5?api_token=YOUR_API_TOKEN&api_token_secret=YOUR_API_TOKEN_SECRET"
Response
{
"result_ok": true,
"data": {
"id": 5,
"base_type": "Question",
"type": "CHECKBOX",
"title": {
"English": "Checkbox question 1"
},
"shortname": "",
"varname": [],
"description": [],
"has_showhide_deps": false,
"comment": false,
"properties": {
"option_sort": "NONE",
"required": false,
"hidden": false,
"element_style": "OS",
"orientation": "VERT",
"labels_right": true,
"show_title": false,
"question_description": {
"English": ""
},
"question_description_above": false,
"soft-required": false,
"disabled": false,
"save_logic_data": false,
"messages": {
"inputmask": [],
"r_extreme_label": [],
"l_extreme_label": [],
"th_content": []
},
"hide_after_response": false,
"admin_question": false,
"custom_css": "",
"break_after": false,
"url": "http://",
"show_rules": {
"atom": {
"type": "3",
"value": "4",
"case_sensitive": true
},
"operator": "12",
"atom2": {
"type": "17",
"value": [
"4-10005"
],
"case_sensitive": false
},
"id": "690921b33dc9c",
"same_page_skus": []
}
},
"options": [
{
"id": 10007,
"title": { "English": "Option 1" },
"value": "Option 1",
"properties": { "disabled": false }
},
{
"id": 10008,
"title": { "English": "Option 2" },
"value": "Option 2",
"properties": { "disabled": false }
},
{
"id": 10009,
"title": { "English": "Option 3" },
"value": "Option 3",
"properties": { "disabled": false }
}
],
"show_rules_ids": "690921b33dc9c"
}
}