Themes
Theme configurations control the visual styling of the S-Launch UI for a tenant — colors, fonts, logos, and other branding-level settings. Multiple theme configs can be stored; exactly one is active at any time.
Scopes
| Scope | Reach |
|---|---|
themes:read | Listing, reading, fetching the active theme, viewing filters. |
themes:write | Creating, updating, deleting themes, and activating one. |
Endpoints
List Theme Configs
GET /api/themes/
Returns a page of theme configurations.
Required scope: themes:read · also accepts API key
Query parameters — standard pagination set; see Conventions › Pagination. Defaults: sort_by=created, sort_order=desc, hydrate=true.
Response 200 — ThemeConfigInDbCursorPage
Get Active Theme
GET /api/themes/active
Returns the currently active theme — what the UI is rendering right now.
Required scope: themes:read
Response 200 — ThemeRead
Get Theme Filter Metadata
GET /api/themes/filters
Returns filter/operator/sort options for List Theme Configs.
Required scope: themes:read
Response 200 — open metadata object.
Get Theme Config by ID
GET /api/themes/{id}
Returns a single theme configuration.
Required scope: themes:read · also accepts API key
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | Theme ID. |
Response 200 — ThemeRead
Create Theme Config
POST /api/themes/
Creates a new theme configuration.
Required scope: themes:write
Request body — ThemeWriteCreate
Response 201 — ThemeRead
Update Theme Config by ID
PUT /api/themes/{id}
Replaces the theme configuration.
Required scope: themes:write
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | Theme ID. |
Request body — ThemeWriteReplace
Response 200 — ThemeRead
Patch Theme Config
PATCH /api/themes/{id}
Partial theme configuration update.
Required scope: themes:write
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | Theme ID. |
Request body — ThemeWriteUpdate
Response 200 — ThemeRead
Delete Theme Config by ID
DELETE /api/themes/{id}
Deletes a theme configuration. The active theme cannot be deleted — activate another theme first.
Required scope: themes:write
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | Theme ID. |
Response 204 — empty.
Activate Theme
POST /api/themes/{id_or_name}/activate
Switches the active theme to the specified configuration. The path segment accepts either the theme's ID or its unique name — whichever is more convenient.
Required scope: themes:write
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id_or_name | string | yes | Theme ID or unique name to activate. |
Response 200 — ThemeRead — the now-active theme.
See also
- UI Variables — finer-grained control over individual style variables.
- Mail Templates — branded email content (separate from in-app theming).