Skip to main content
GET
Get theme settings

Authorizations

Authorization
string
header
required

Bearer token: a shop API key (WEAVERSE_API_KEY), a scoped API key or a delegated MCP OAuth token; translation-unit routes also accept a project-bound translation agent token. Each operation lists the scope it requires; the scope table is in the API description.

Path Parameters

projectId
string
required

Query Parameters

locale
string

Locale code (e.g. "fr-fr"). When provided, the response includes a staticTranslations field with resolved translation values. Tries exact locale match first, then falls back to language prefix.

format
enum<string>
default:weaverse

Output format for rich-text fields.

  • weaverse (default): rich text returned as HTML strings — original behavior, no migration needed.
  • portable-text: rich text returned as structured Portable Text blocks for multi-channel rendering and AI consumption.

Equivalent to setting Accept: application/portable-text+json on the request. The query parameter takes precedence over the header when both are provided. An invalid value returns 400 INVALID_PARAMS.

Available options:
weaverse,
portable-text
view
enum<string>
default:own

own: this project's theme bucket plus its revision (the PATCH baseline). effective: the parent theme merged under this project's overrides plus inheritance metadata; read-only, carries no revision.

Available options:
own,
effective

Response

Theme settings with optional static translations

object
enum<string>

theme_settings for view=own; theme_settings_effective for view=effective

Available options:
theme_settings,
theme_settings_effective
projectId
string
theme
object

Theme configuration JSON. Empty object if not configured.

staticTranslations
object | null

Nested translation keys with resolved values for the requested locale. Only present when locale query parameter is provided. Uses translated value when available, falls back to default value.

revision
string<date-time> | null

Project revision captured together with the theme in this response (they are cached as one snapshot). Pass back as expectedRevision on PATCH: if the settings changed since this snapshot — including when the snapshot itself was served from cache — the PATCH is rejected with 409 STALE_PROJECT; re-read and reapply.

inheritance
object

Only for view=effective (which carries no revision).