List Survey Options
Returns a list of all options for the specified survey question.
Endpoint
GET
v5/survey/{survey_id}/surveyquestion/{question_id}/surveyoption
Requires authentication
Path Parameters
The survey and question whose options should be retrieved.
survey_id
string
required
The ID of the survey containing the question.
question_id
string
required
The ID of the question whose options will be listed.
Query Parameters
This endpoint does not accept additional query parameters beyond authentication credentials.
None
Response
Returns a list of survey option objects for the specified question.
result_ok
boolean
Whether the request succeeded.
total_count
integer
Total number of options for this question.
page
integer
Current page index.
total_pages
integer
Number of available pages.
results_per_page
string
Number of options returned per page.
data
array
Array of survey option objects.
child attributes
id
integer
The unique ID (SKU) of the option.
title
object
The display text of the option, keyed by language. Example:
{"English": "Yes"}.value
string
The reporting value of the option.
properties
object
Configuration properties set on the option. Only properties with non-default values are returned.
child attributes
disabled
boolean
Whether this option is disabled and hidden from respondents.
other
boolean
Whether this option includes an open-text “Other” field.
requireother
boolean
Whether the “Other” text field is required when this option is selected.
na
boolean
Whether this option is designated as a “Not Applicable” choice.
none
boolean
Whether this option is designated as a “None” choice.
all
boolean
Whether this option is designated as a “Select All” choice.
fixed
boolean
Whether this option is pinned to a fixed position when randomization is enabled.
heatmap-color
string
Hex color code (without
#) used to represent this option in heatmap reports.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/YOUR_SURVEY_ID/surveyquestion/YOUR_QUESTION_ID/surveyoption?api_token=YOUR_API_TOKEN&api_token_secret=YOUR_API_TOKEN_SECRET"
Response
{
"result_ok": true,
"total_count": 3,
"page": 1,
"total_pages": 1,
"results_per_page": "50",
"data": [
{
"id": 10001,
"title": {
"English": "Yes"
},
"value": "Yes",
"properties": {
"disabled": false,
"other": false
}
},
{
"id": 10002,
"title": {
"English": "No"
},
"value": "No",
"properties": {
"disabled": false,
"other": false
}
},
{
"id": 10003,
"title": {
"English": "Other"
},
"value": "Other",
"properties": {
"disabled": false,
"other": true
}
}
]
}