Get theme

Returns a guides and surveys theme. config is the live theme by default.
Archived themes return 404.

get/v1/projects/{project_id}/themes/{theme_id}

Authorizations

Authorizationstringrequired

http

Path parameters

project_idstringrequired

Amplitude project identifier, backed by the canonical app ID.

Example:12345
Constraints:pattern: ^[0-9]+$
theme_idstringrequired

Guides and surveys theme identifier.

Constraints:pattern: ^[0-9]+$

Query parameters

include_unpublished_changesboolean

When true, config is the unpublished draft instead of the live theme. Use has_unpublished_changes to check whether a draft differs.

Default:false

Response

application/json
200· Successful response.
dataobjectrequired
Show child attributes
idstringrequired

Numeric theme identifier.

Constraints:pattern: ^[0-9]+$
objectstringrequired
project_idstringrequired
Constraints:pattern: ^[0-9]+$
namestringrequired
platformstringrequired

Target platform. Guides and surveys without an explicit platform are returned as web.

Allowed values:webiosandroidreact-nativedesktopflutter
is_defaultbooleanrequired

Whether this is the project's default theme for its platform. Guides and surveys with no theme_id use it.

is_internalbooleanrequired

Internal 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_archivedbooleanrequired
has_unpublished_changesbooleanrequired

Whether the unpublished draft differs from the live theme.

urlstringrequired

Admin URL for the theme. null for internal themes.

Constraints:format: urinullable
created_bystringrequired
Constraints:nullable
last_modified_bystringrequired
Constraints:nullable
created_atstringrequired
Constraints:format: date-timenullable
updated_atstringrequired
Constraints:format: date-timenullable
configoneOfrequired

Theme configuration. Live by default; the unpublished draft with include_unpublished_changes=true. null when the theme has no saved configuration.

Constraints:objectnull
lightModeobject
varDefaultsobjectrequired

CSS 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).

Example:{"--base-accent":"rgb(120, 86, 255)","--font-size-base":"14px","--font-weight-bold":700}
varOverridesobjectrequired

CSS 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).

Example:{"--base-accent":"rgb(120, 86, 255)","--font-size-base":"14px","--font-weight-bold":700}
componentOverridesobjectrequired

Per-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.

Example:{"tooltip":{"--background-color":"#ffffff"}}
mobileOverridesobjectrequired

Overrides applied by the mobile SDKs.

customCssstring

Custom CSS appended to the theme.

darkModeobject
varDefaultsobjectrequired

CSS 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).

Example:{"--base-accent":"rgb(120, 86, 255)","--font-size-base":"14px","--font-weight-bold":700}
varOverridesobjectrequired

CSS 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).

Example:{"--base-accent":"rgb(120, 86, 255)","--font-size-base":"14px","--font-weight-bold":700}
componentOverridesobjectrequired

Per-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.

Example:{"tooltip":{"--background-color":"#ffffff"}}
mobileOverridesobjectrequired

Overrides applied by the mobile SDKs.

customCssstring

Custom 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.