---
title: Get theme
description: Returns a guides and surveys theme. config is the live theme by default. Archived themes return 404 .
product: general
lang: en
last_updated: 2026-10-30
token_estimate: 2558
---
# Get theme

## Get theme

**GET** `/v1/projects/{project_id}/themes/{theme_id}`

Full URL: `https://developer-api.amplitude.com/v1/projects/{project_id}/themes/{theme_id}`

> For AI agents: a documentation index is available at [/docs/llms.txt](/docs/llms.txt). Append `.md` to any page URL for markdown, or send `Accept: text/markdown`.

**Servers:**
- Production (US): `https://developer-api.amplitude.com/v1/projects/{project_id}/themes/{theme_id}`
- Production (EU): `https://developer-api.eu.amplitude.com/v1/projects/{project_id}/themes/{theme_id}`

Get theme

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

## Authorizations

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| Authorization | string | Yes | — | http |

## Path parameters

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| project_id (path) | string | Yes | 12345 | Amplitude project identifier, backed by the canonical app ID. Constraints: pattern: ^[0-9]+$ |
| theme_id (path) | string | Yes | — | Guides and surveys theme identifier. Constraints: pattern: ^[0-9]+$ |

## Query parameters

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| include_unpublished_changes (query) | boolean | No | false | When true, `config` is the unpublished draft instead of the live theme. Use `has_unpublished_changes` to check whether a draft differs. |

## Response (application/json)

**200** — Successful response.

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| data | object | Yes | — | — |
| data.id | string | Yes | — | Numeric theme identifier. Constraints: pattern: ^[0-9]+$ |
| data.object | string | Yes | — | — |
| data.project_id | string | Yes | — | Constraints: pattern: ^[0-9]+$ |
| data.name | string | Yes | — | — |
| data.platform | string | Yes | — | Target platform. Guides and surveys without an explicit platform are returned as `web`. Allowed values: web, ios, android, react-native, desktop, flutter |
| data.is_default | boolean | Yes | — | Whether this is the project's default theme for its platform. Guides and surveys with no `theme_id` use it. |
| data.is_internal | boolean | Yes | — | 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`. |
| data.is_archived | boolean | Yes | — | — |
| data.has_unpublished_changes | boolean | Yes | — | Whether the unpublished draft differs from the live theme. |
| data.url | string | Yes | — | Admin URL for the theme. `null` for internal themes. Constraints: format: uri, nullable |
| data.created_by | string | Yes | — | Constraints: nullable |
| data.last_modified_by | string | Yes | — | Constraints: nullable |
| data.created_at | string | Yes | — | Constraints: format: date-time, nullable |
| data.updated_at | string | Yes | — | Constraints: format: date-time, nullable |
| data.config | oneOf | Yes | — | Theme configuration. Live by default; the unpublished draft with `include_unpublished_changes=true`. `null` when the theme has no saved configuration. Constraints: object, null |
| data.config.lightMode | object | No | — | — |
| data.config.lightMode.varDefaults | object | Yes | {"--base-accent":"rgb(120, 86, 255)","--font-size-base":"14px","--font-weight-bold":700} | 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)`. |
| data.config.lightMode.varOverrides | object | Yes | {"--base-accent":"rgb(120, 86, 255)","--font-size-base":"14px","--font-weight-bold":700} | 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)`. |
| data.config.lightMode.componentOverrides | object | Yes | {"tooltip":{"--background-color":"#ffffff"}} | 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. |
| data.config.lightMode.mobileOverrides | object | Yes | — | Overrides applied by the mobile SDKs. |
| data.config.lightMode.customCss | string | No | — | Custom CSS appended to the theme. |
| data.config.darkMode | object | No | — | — |
| data.config.darkMode.varDefaults | object | Yes | {"--base-accent":"rgb(120, 86, 255)","--font-size-base":"14px","--font-weight-bold":700} | 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)`. |
| data.config.darkMode.varOverrides | object | Yes | {"--base-accent":"rgb(120, 86, 255)","--font-size-base":"14px","--font-weight-bold":700} | 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)`. |
| data.config.darkMode.componentOverrides | object | Yes | {"tooltip":{"--background-color":"#ffffff"}} | 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. |
| data.config.darkMode.mobileOverrides | object | Yes | — | Overrides applied by the mobile SDKs. |
| data.config.darkMode.customCss | string | No | — | Custom CSS appended to the theme. |

```json
{
  "data": {
    "id": "string",
    "object": "theme",
    "project_id": "string",
    "name": "string",
    "platform": "web",
    "is_default": true,
    "is_internal": true,
    "is_archived": true,
    "has_unpublished_changes": true,
    "url": "https://example.com",
    "created_by": "string",
    "last_modified_by": "string",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "config": {
      "lightMode": {
        "varDefaults": {
          "--base-accent": "rgb(120, 86, 255)",
          "--font-size-base": "14px",
          "--font-weight-bold": 700
        },
        "varOverrides": {
          "--base-accent": "rgb(120, 86, 255)",
          "--font-size-base": "14px",
          "--font-weight-bold": 700
        },
        "componentOverrides": {
          "tooltip": {
            "--background-color": "#ffffff"
          }
        },
        "mobileOverrides": {},
        "customCss": "string"
      },
      "darkMode": {
        "varDefaults": {
          "--base-accent": "rgb(120, 86, 255)",
          "--font-size-base": "14px",
          "--font-weight-bold": 700
        },
        "varOverrides": {
          "--base-accent": "rgb(120, 86, 255)",
          "--font-size-base": "14px",
          "--font-weight-bold": 700
        },
        "componentOverrides": {
          "tooltip": {
            "--background-color": "#ffffff"
          }
        },
        "mobileOverrides": {},
        "customCss": "string"
      }
    }
  }
}
```

**400**

**401**

**403**

**404**

**429**

**500**

## Code samples

### cURL

```bash
curl -X GET "https://developer-api.amplitude.com/v1/projects/12345/themes/{theme_id}?include_unpublished_changes=false" \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://developer-api.amplitude.com/v1/projects/12345/themes/{theme_id}?include_unpublished_changes=false",
    headers={
        "Content-Type": "application/json",
        "Authorization": "YOUR_API_KEY"
    }
)
data = response.json()
```

### JavaScript

```javascript
const response = await fetch("https://developer-api.amplitude.com/v1/projects/12345/themes/{theme_id}?include_unpublished_changes=false", {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_KEY"
  }
});
const data = await response.json();
```

### PHP

```php
<?php
$ch = curl_init("https://developer-api.amplitude.com/v1/projects/12345/themes/{theme_id}?include_unpublished_changes=false");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Content-Type: application/json",
    "Authorization: YOUR_API_KEY"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
```

### Go

```go
package main

import (
  "bytes"
  "net/http"
)

func main() {
req, _ := http.NewRequest("GET", "https://developer-api.amplitude.com/v1/projects/12345/themes/{theme_id}?include_unpublished_changes=false", nil)
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "YOUR_API_KEY")
  client := &http.Client{}
  resp, _ := client.Do(req)
  defer resp.Body.Close()
}
```

### Java

```java
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
      .uri(URI.create("https://developer-api.amplitude.com/v1/projects/12345/themes/{theme_id}?include_unpublished_changes=false"))
      .method("GET", HttpRequest.BodyPublishers.noBody())
.header("Content-Type", "application/json")
      .header("Authorization", "YOUR_API_KEY")
      .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```ruby
require "net/http"
require "json"

uri = URI("https://developer-api.amplitude.com/v1/projects/12345/themes/{theme_id}?include_unpublished_changes=false")
request = Net::HTTP::Get.new(uri)
request["Content-Type"] = "application/json"
request["Authorization"] = "YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
```

