Get Survey Theme
Returns detailed information about a specific theme in your account's theme library.
Endpoint
GET
v5/surveytheme/{theme_id}
Requires authentication
Path Parameters
The theme to retrieve.
theme_id
string
required
The ID of the theme to retrieve.
Query Parameters
This endpoint does not accept additional query parameters beyond authentication credentials.
None
Response
Returns a single survey theme object.
result_ok
boolean
Whether the request succeeded.
data
object
The survey theme object.
child attributes
id
integer
The unique ID of the theme.
status
string
The theme's status. Possible value:
Active.created
string | null
Timestamp when the theme was created, or
null.name
string
The display name of the theme.
style_options
object
The full set of visual styling options for the theme.
child attributes
body background color
string
Hex color code for the survey background. Example:
#ffffff.body background opacity
string
Opacity of the background color or image. Range:
0.0 to 1.00.background image style
string
How the background image is displayed. Values:
cover, tile, left, right, center.background grad orient
string
Gradient orientation. Values:
vertical, horizontal.header background color
string
Hex color code for the header background.
header background opacity
string
Opacity of the header background. Range:
0.0 to 1.00.header text color
string
Hex color code for text in the header.
page background color
string
Hex color code for the page (content area) background.
page background opacity
string
Opacity of the page background. Range:
0.0 to 1.00.accent
string
Hex color code for accent elements — Next, Back, and Submit buttons and the Progress Bar.
accent text
string
Hex color code for text on accent-colored elements.
title font family
string
Font family for the survey title. Example:
Montserrat.title font size
string
Font size for the survey title. Example:
36px.title font weight
string
Font weight for the survey title. Example:
400.base font family
string
Font family for body text. Example:
Arial.base font size
string
Font size for body text. Example:
14px.base font weight
string
Font weight for body text. Example:
400.base font color
string
Hex color code for body text.
survey title
string
Whether the survey title is shown. Values:
"true", "false".title align
string
Alignment of the survey title. Values:
left, center, right.page title
string
Whether page titles are shown. Values:
"true", "false".page description
string
Whether page descriptions are shown. Values:
"true", "false".question numbers
string
Whether question numbers are shown. Values:
"true", "false".required ast
string
Whether the required asterisk (*) symbol is shown. Values:
"true", "false".question border
string
Whether question borders are shown. Values:
"true", "false".back button
string
Whether the Back button is shown. Values:
"true", "false".progress bar
string
Whether the progress bar is shown. Values:
"true", "false".survey width
string
The survey width as a combined value. Example:
80%.survey width number
string
The numeric survey width value.
survey width unit
string
The unit for survey width. Values:
%, px.page width
string
The page width as a combined value. Example:
100%.page width number
string
The numeric page width value.
page width unit
string
The unit for page width. Values:
%, px.survey round corner number
string
Corner rounding value for the survey page. Range:
0–100. Higher values produce more rounded corners.header image url
string
URL of the header image.
img width
string
Percentage width for the header image. Range:
1–100.img width max
string
Maximum percentage width for the header image. Range:
1–100.custom-head
string
Custom HTML injected into the
<head> of the survey.theme_version
string
The internal version of the theme format.
powered by
string
Whether the “Powered by Alchemer” footer is shown. Values:
"true", "false".auto mobile
string
Whether mobile-optimized display is enabled automatically. Values:
"true", "false".page title align
string
Alignment of page titles. Values:
left, center, right.question title
string
Whether question titles are shown. Values:
"true", "false".so-masthead-image-show
string
Whether the masthead image is shown. Values:
"true", "false".replace icons
string
Whether default icons are replaced with theme-specific icons. Values:
"true", "false".image align
string
CSS margin value controlling the alignment of the header image. Example:
0 auto 0 0.theme_id
string
The ID of the base theme this theme inherits from.
style mode
string
How this theme's styles are applied relative to its base theme. Value:
append.theme-css
string
Internal CSS cache identifier for the theme.
mobile-calculated-colors
string
Whether colors are automatically calculated for mobile display. Values:
"true", "false".mobile-logo-alignment
string
Whether logo alignment is automatically adjusted for mobile display. Values:
"true", "false".Body
string
The theme's HTML template body, containing the structural layout of the survey.
css
string
Custom CSS applied to the theme.
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/surveytheme/YOUR_THEME_ID?api_token=YOUR_API_TOKEN&api_token_secret=YOUR_API_TOKEN_SECRET"
Response
{
"result_ok": true,
"data": {
"id": 290549,
"status": "Active",
"created": null,
"name": "My New Theme",
"style_options": {
"custom-head": "<!-- Write your custom HTML here -->\n",
"theme_version": "2",
"body background color": "#ffffff",
"body background opacity": "1.00",
"page background color": "#ffffff",
"page background opacity": "",
"header background color": "#ffffff",
"header background opacity": "1.00",
"header text color": "#354050",
"base font color": "#2c3e50",
"accent": "#354050",
"accent text": "#ffffff",
"image align": "0 auto 0 0",
"img width": "100",
"img width max": "100",
"background image style": "tile",
"background grad orient": "vertical",
"title font family": "Montserrat",
"title font size": "18px",
"title font weight": "400",
"base font family": "Montserrat",
"base font size": "14px",
"base font weight": "400",
"survey title": "true",
"title align": "left",
"back button": "true",
"progress bar": "true",
"page title": "true",
"page title align": "left",
"page description": "true",
"question numbers": "true",
"required ast": "true",
"question border": "true",
"survey width number": "100",
"survey width unit": "%",
"page width number": "960",
"page width unit": "px",
"survey round corner number": "0",
"question title": "true",
"survey width": "100%",
"page width": "960px",
"powered by": "false",
"auto mobile": "false",
"so-masthead-image-show": "false",
"replace icons": "true",
"theme_id": "282335",
"style mode": "append",
"header image url": "//app.alchemer.com/public/images/spacer.gif",
"theme-css": "c65d81bf99132",
"mobile-calculated-colors": "true",
"mobile-logo-alignment": "true"
},
"Body": "<div class=\"sg-wrapper\">...</div>",
"css": "/* Write your custom CSS here */\n"
}
}