Get theme
Returns a guides and surveys theme. config is the live theme by default.
Archived themes return 404.
/v1/projects/{project_id}/themes/{theme_id}Authorizations
Authorizationstringrequiredhttp
Path parameters
project_idstringrequiredAmplitude project identifier, backed by the canonical app ID.
12345pattern: ^[0-9]+$theme_idstringrequiredGuides and surveys theme identifier.
pattern: ^[0-9]+$Query parameters
include_unpublished_changesbooleanWhen true, config is the unpublished draft instead of the live
theme. Use has_unpublished_changes to check whether a draft differs.
falseResponse
application/jsondataobjectrequiredShow child attributes
idstringrequiredNumeric theme identifier.
pattern: ^[0-9]+$objectstringrequiredproject_idstringrequiredpattern: ^[0-9]+$namestringrequiredplatformstringrequiredTarget platform. Guides and surveys without an explicit platform are
returned as web.
webiosandroidreact-nativedesktopflutteris_defaultbooleanrequiredWhether this is the project's default theme for its platform. Guides
and surveys with no theme_id use it.
is_internalbooleanrequiredInternal themes are per-guide or per-survey overrides created in the
guide or survey editor. Lists omit them; get them by id through a
guide or survey's theme_id.
is_archivedbooleanrequiredhas_unpublished_changesbooleanrequiredWhether the unpublished draft differs from the live theme.
urlstringrequiredAdmin URL for the theme. null for internal themes.
format: urinullablecreated_bystringrequirednullablelast_modified_bystringrequirednullablecreated_atstringrequiredformat: date-timenullableupdated_atstringrequiredformat: date-timenullableconfigoneOfrequiredTheme configuration. Live by default; the unpublished draft with
include_unpublished_changes=true. null when the theme has no
saved configuration.
objectnulllightModeobjectvarDefaultsobjectrequiredCSS variable values keyed by variable name. Colors accept any CSS color
(#ff0000, rgb(), color-mix(), var(--token)). Sizes need a unit
(12px, 1.5rem, 100%). Numbers such as font weights may be JSON
numbers or numeric strings. Any value may reference another variable with
var(--name).
{"--base-accent":"rgb(120, 86, 255)","--font-size-base":"14px","--font-weight-bold":700}varOverridesobjectrequiredCSS variable values keyed by variable name. Colors accept any CSS color
(#ff0000, rgb(), color-mix(), var(--token)). Sizes need a unit
(12px, 1.5rem, 100%). Numbers such as font weights may be JSON
numbers or numeric strings. Any value may reference another variable with
var(--name).
{"--base-accent":"rgb(120, 86, 255)","--font-size-base":"14px","--font-weight-bold":700}componentOverridesobjectrequiredPer-component overrides keyed by component slug (for example
tooltip or modal). Each entry maps a key to a CSS variable value or
to a map of CSS variables.
{"tooltip":{"--background-color":"#ffffff"}}mobileOverridesobjectrequiredOverrides applied by the mobile SDKs.
customCssstringCustom CSS appended to the theme.
darkModeobjectvarDefaultsobjectrequiredCSS variable values keyed by variable name. Colors accept any CSS color
(#ff0000, rgb(), color-mix(), var(--token)). Sizes need a unit
(12px, 1.5rem, 100%). Numbers such as font weights may be JSON
numbers or numeric strings. Any value may reference another variable with
var(--name).
{"--base-accent":"rgb(120, 86, 255)","--font-size-base":"14px","--font-weight-bold":700}varOverridesobjectrequiredCSS variable values keyed by variable name. Colors accept any CSS color
(#ff0000, rgb(), color-mix(), var(--token)). Sizes need a unit
(12px, 1.5rem, 100%). Numbers such as font weights may be JSON
numbers or numeric strings. Any value may reference another variable with
var(--name).
{"--base-accent":"rgb(120, 86, 255)","--font-size-base":"14px","--font-weight-bold":700}componentOverridesobjectrequiredPer-component overrides keyed by component slug (for example
tooltip or modal). Each entry maps a key to a CSS variable value or
to a map of CSS variables.
{"tooltip":{"--background-color":"#ffffff"}}mobileOverridesobjectrequiredOverrides applied by the mobile SDKs.
customCssstringCustom CSS appended to the theme.
Was this helpful?
For AI agents: a documentation index is available at /docs/llms.txt. Append .md to any page URL for markdown, or send Accept: text/markdown.