List Survey Pages
Returns a list of all pages for the specified survey.
Endpoint
GET
v5/survey/{survey_id}/surveypage
Requires authentication
Path Parameters
The survey whose pages should be retrieved.
survey_id
string
required
The ID of the survey whose pages will be listed.
Query Parameters
This endpoint does not accept additional query parameters beyond authentication credentials.
None
Response
Returns a paginated list of survey page objects.
result_ok
boolean
Whether the request succeeded.
total_count
integer
Total number of pages in the survey.
page
integer
Current page index.
total_pages
integer
Number of available pages.
results_per_page
integer
Number of results returned per page.
data
array
Array of survey page objects.
child attributes
id
string
The unique ID of the page.
title
string
The title of the page.
description
string
The description text displayed on the page.
properties
object
Configuration properties set on the page.
child attributes
hidden
boolean
Whether the page is hidden from respondents.
piped_from
string
The ID of the question whose answer is piped onto this page.
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/surveypage?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": "1",
"title": "Page 1",
"description": "",
"properties": {
"hidden": false,
"piped_from": ""
}
},
{
"id": "2",
"title": "Page 2",
"description": "",
"properties": {
"hidden": false,
"piped_from": ""
}
}
]
}