Themes
Themes control fonts, colours and branding assets used across headless experiences. You can create, update and delete themes via the API.
Get themes Scale and above
Use this endpoint to list themes in your workspace.
GET/v1/headless/themes
Query parameters
| Field | Type | Required | Default | Description | Options |
|---|
length | number | No | — | | — |
Get theme Scale and above
Use this endpoint to fetch a single theme by ID.
GET/v1/headless/themes/{id}
Path parameters
| Field | Description | Options |
|---|
id | Theme ID | — |
Create theme Scale and above
Use this endpoint to create a new theme.
cover-specific colour fields are ignored by this endpoint.
POST/v1/headless/themes
Body parameters
| Field | Type | Required | Desc | Options |
|---|
name | string | Yes | Theme name | — |
fonts | object | No | Font settings ({ heading: { family }, body: { family } }) | — |
colours | object | No | Colour palette (keyed by role) | — |
logoId | number | null | No | Asset ID of the uploaded logo | — |
config | object | No | Additional theme configuration | — |
Update theme Scale and above
Use this endpoint to update an existing theme.
cover-specific colour fields are ignored by this endpoint.
PUT/v1/headless/themes/{id}
Path parameters
| Field | Description | Options |
|---|
id | Theme ID | — |
Body parameters
| Field | Type | Required | Desc | Options |
|---|
name | string | Yes | Theme name | — |
fonts | object | No | Font settings | — |
colours | object | No | Colour palette | — |
logoId | number | null | No | Asset ID of the uploaded logo | — |
config | object | No | Additional theme configuration | — |
default | boolean | No | Whether this theme is the workspace default | — |
Delete theme Scale and above
Use this endpoint to delete an existing theme.
DELETE/v1/headless/themes/{id}
Path parameters
| Field | Description | Options |
|---|
id | Theme ID | — |